package async

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

Monadic concurrency library

Install

dune-project

Dependency

github.com Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

async-v0.12.0.tar.gz

sha256=c1cd9fa74e975ae5a014dffb36283d2616d89e465a9d4dec3062da70866ed28f

md5=e9a06695c63cf4b092cc81f25a8491fd

doc/async.lock_file_async/Lock_file_async/index.html

Module `Lock_file_async`

Async.Lock_file is a wrapper that provides Async equivalents for Lock_file.

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.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