package async_unix

  1. Overview
  2. Docs
package async_unix
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Thread_safe_pipeSource

A thread-safe pipe is a thread-safe interface to the write end of a normal Async.Pipe. All operations except for create must be called from threads outside Async, while create can be called from inside or outside Async.

For Pipe functions that return a unit Deferred.t, the analog in Thread_safe_pipe blocks.

For documentation of wakeup_scheduler, see the Thread_safe module.

Sourcetype 'a t

The writer end of the pipe.

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
Sourceval create : unit -> 'a Async_kernel.Pipe.Reader.t * 'a t

create () returns a reader end, which must be used inside Async, and a writer end, which must be used outside Async. create can be called inside or outside Async.

All the following functions must be called outside Async. They behave as their counterpart in the Pipe module.

Sourceval pushback : _ t -> unit

pushback writer blocks the current thread until the pipe is empty or closed.

Sourcemodule Written_or_closed : sig ... end
Sourcemodule If_closed : sig ... end

Functions that write elements to the pipe take an If_closed.t argument to specify how to deal with the possibility that the pipe is closed.

Sourceval transfer_in_without_pushback : ?wakeup_scheduler:bool -> 'a t -> from:'a Core.Queue.t -> if_closed:'b If_closed.t -> 'b

transfer_in_without_pushback' and write_without_pushback transfer the element(s) into the pipe and return immediately.

Sourceval write_without_pushback : ?wakeup_scheduler:bool -> 'a t -> 'a -> if_closed:'b If_closed.t -> 'b
Sourceval transfer_in : 'a t -> from:'a Core.Queue.t -> if_closed:'b If_closed.t -> 'b

transfer_in and write transfer the element(s) into the pipe and block the current thread until the pipe is empty or closed (like pushback).

Sourceval write : 'a t -> 'a -> if_closed:'b If_closed.t -> 'b
Sourceval close : _ t -> unit
Sourceval is_closed : _ t -> bool
Sourceval closed : _ t -> unit

closed writer blocks the current thread until the pipe is closed.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct