package sessions

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t

The monadic light weight thread type returning value 'a.

type chan_endpoint

The abstract type representing one end of a communication channel.

type chan =
  1. | Chan : chan_endpoint * chan_endpoint -> chan
    (*

    A channel consists of two Binary_session.IO.chan_endpoint.

    *)

The abstract type representing a communication channel between two processes.

val make_channel : unit -> chan

make_channel () will return a new communication channel Binary_session.IO.chan.

val read_channel : chan_endpoint -> 'a t

read_channel end_point reads a marshalled value from end_point and returns it.

val write_channel : 'a -> flags:Marshal.extern_flags list -> chan_endpoint -> unit t

write_channel v flags end_point marshals the value v according to flags and writes it to end_point.

val close_channel : chan -> unit t

close_channel c will close the given channel c.

val return : 'a -> 'a t

return v creates a light weight thread returning v.

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

bind t f is a thread which first waits for the thread t to terminate and then, behaves as the application of function f to the return value of t.

OCaml

Innovation. Community. Security.