package async

  1. Overview
  2. Docs
Monadic concurrency library

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

async-v0.13.0.tar.gz
sha256=fef9ebe342ea59d7804f6292b7891ad664a8ba8d4174a1b202db91363a9c71ab
md5=fbfc7059179bc9ddd5dc1411e7d2e815

doc/async.lock_file_async/Lock_file_async/index.html

Module Lock_file_async

Lock_file_async is a wrapper that provides Async equivalents for Lock_file_blocking.

val create : ?message:string -> ?close_on_exec:bool -> ?unlink_on_exit:bool -> string -> bool Async.Deferred.t

create ?message path tries to create a file at path containing the text message, pid if none provided. It returns true on success, false on failure. Note: there is no way to release the lock or the fd created inside! It will only be released when the process dies.

val create_exn : ?message:string -> ?close_on_exec:bool -> ?unlink_on_exit:bool -> string -> unit Async.Deferred.t

create_exn ?message path is like create except that it throws an exception on failure instead of returning a boolean value.

val waiting_create : ?abort:unit Async.Deferred.t -> ?message:string -> ?close_on_exec:bool -> ?unlink_on_exit:bool -> string -> unit Async.Deferred.t

waiting_create path repeatedly tries to lock path, becoming determined when path is locked or raising when abort becomes determined. Similar to Lock_file_blocking.create.

val is_locked : string -> bool Async.Deferred.t

is_locked path returns true when the file at path exists and is locked, false otherwise.

module Nfs : sig ... end

Nfs has analogs of functions in Lock_file_blocking.Nfs; see there for documentation. In addition to adding Deferred's, blocking_create was renamed waiting_create to avoid the impression that it blocks Async.

module Flock : sig ... end