package async

You can search for identifiers within the package.

in-package search v0.2.0

package async

async
- Async
  - Command
  - Deferred
    
    Or_error
    
    Expect_test_config
    
    IO
  - Expect_test_config
    
    IO
  - Expect_test_config_or_error
    
    IO
  - Ppx_log_syntax
    
    Global
    
    No_global
    
    Ppx_log_syntax
    
    Global
  - Quickcheck
async.async_command
- Async_command
  - Staged
async.async_quickcheck
- Async_quickcheck
  - Configure
    
    Config
async.async_rpc
- Async_rpc
  - Rpc
    
    Connection
    
    Low_latency_transport
    
    Config
    
    Reader
    
    With_internal_reader
    
    With_internal_reader
    
    Writer
    
    Transport
    
    Reader
    
    Tcp
    
    Writer
async.lock_file_async
- Lock_file_async
  - Flock
  - Nfs
  - Symlink
async.log_extended
- Log_extended
  - Command
  - Console
    
    Blocking
  - Syslog
    
    Blocking
async.persistent_connection
- Persistent_connection
  - Make
    
    Conn
    
    Event
  - Rpc
    
    Event
  - S
    
    Event
  - S_rpc
    
    Event
  - Versioned_rpc
    
    Event
async.unpack_sequence
- Unpack_sequence

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

Flock has async analogues of functions in Lock_file_blocking.Flock; see there for documentation.

Additionally, here we:

catch unix exceptions, packaging them as Deferred.Or_error.t
implement abortable waiting versions based on polling

val lock_exn : 
  ?lock_owner_uid:int ->
  ?exclusive:bool ->
  ?close_on_exec:bool ->
  lock_path:string ->
  unit ->
  [ `Somebody_else_took_it | `We_took_it of t ] Async.Deferred.t

lock_exn ?lock_owner_uid ~lock_path () Attempt to take the lock at lock_path. It optionally also sets the owner id to lock_owner_uid.

val lock : 
  ?lock_owner_uid:int ->
  ?exclusive:bool ->
  ?close_on_exec:bool ->
  lock_path:string ->
  unit ->
  [ `Somebody_else_took_it | `We_took_it of t ] Async.Deferred.Or_error.t

val unlock_exn : t -> unit Async.Deferred.t

val unlock : t -> unit Async.Deferred.Or_error.t

val wait_for_lock_exn : 
  ?abort:unit Async.Deferred.t ->
  ?lock_owner_uid:int ->
  ?exclusive:bool ->
  ?close_on_exec:bool ->
  lock_path:string ->
  unit ->
  t Async.Deferred.t

wait_for_lock_exn ?abort ?lock_owner_uid ~lock_path () Wait for the lock, giving up once abort becomes determined. It optionally also sets the owner id to lock_owner_uid.

val wait_for_lock : 
  ?abort:unit Async.Deferred.t ->
  ?lock_owner_uid:int ->
  ?exclusive:bool ->
  ?close_on_exec:bool ->
  lock_path:string ->
  unit ->
  t Async.Deferred.Or_error.t

See wait_for_lock_exn