module Thread_safe_pipe: Thread_safe_pipe
type 'a
t
val create : unit -> 'a Import.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.
val pushback : 'a t -> unit
pushback writer
blocks the current thread until the pipe is empty or closed.
val write_without_pushback' : ?wakeup_scheduler:bool ->
'a t -> 'a Core.Std.Queue.t -> unit
write_without_pushback'
and write_without_pushback
transfer the element(s) into
the pipe and return immediately.
val write_without_pushback : ?wakeup_scheduler:bool -> 'a t -> 'a -> unit
val write' : 'a t -> 'a Core.Std.Queue.t -> unit
write'
and
write
transfer the element(s) into the pipe and block the current
thread until the pipe is empty or closed (like
Thread_safe_pipe.pushback
).
val write : 'a t -> 'a -> unit
val close : 'a t -> unit
val is_closed : 'a t -> bool
val closed : 'a t -> unit
closed writer
blocks the current thread until the pipe is closed.
val sexp_of_t : ('a -> Sexplib.Sexp.t) -> 'a t -> Sexplib.Sexp.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.
pushback writer
blocks the current thread until the pipe is empty or closed.
write_without_pushback'
and write_without_pushback
transfer the element(s) into
the pipe and return immediately.
default is true
default is true
write'
and write
transfer the element(s) into the pipe and block the current
thread until the pipe is empty or closed (like Thread_safe_pipe.pushback
).
closed writer
blocks the current thread until the pipe is closed.