package async_unix
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=49919d67c4197fed6a980a83a5e38f3c7311081dc40480c368c5b572a9cb3bc5
doc/async_unix.thread_safe_pipe/Thread_safe_pipe/index.html
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.
The writer end of the pipe.
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.
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.
val transfer_in_without_pushback :
?wakeup_scheduler:bool ->
'a t ->
from:'a Core.Queue.t ->
if_closed:'b If_closed.t ->
'btransfer_in_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 ->
if_closed:'b If_closed.t ->
'btransfer_in and write transfer the element(s) into the pipe and block the current thread until the pipe is empty or closed (like pushback).