package mirage-flow-combinators

  1. Overview
  2. Docs

Module Mirage_flow_combinatorsSource

This module define flow-related devices for MirageOS, using lwt for I/O.

Release v3.0.0

Sourcemodule type CONCRETE = Mirage_flow.S with type error = [ `Msg of string ] and type write_error = [ Mirage_flow.write_error | `Msg of string ]

CONCRETE expose the private row as `Msg str errors, using pp_error and pp_write_error.

Functor to transform a flow signature using private rows for errors into concrete error types.

Sourcemodule type SHUTDOWNABLE = sig ... end
Sourcemodule F : sig ... end

In-memory, function-based flows.

Sourcetype t

The type for first-class flows.

include Mirage_flow.S with type flow = t
Sourcetype error

The type for flow errors.

Sourceval pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

Sourcetype nonrec write_error = private [>
  1. | Mirage_flow.write_error
]

The type for write errors.

Sourceval pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

Sourcetype flow = t

The type for flows. A flow represents the state of a single reliable stream that is connected to an endpoint.

read flow blocks until some data is available and returns a fresh buffer containing it.

The returned buffer will be of a size convenient to the flow implementation, but will always have at least 1 byte.

If the remote endpoint calls close then calls to read will keep returning data until all the in-flight data has been read. read flow will return `Eof when the remote endpoint has called close and when there is no more in-flight data.

Sourceval write : flow -> Cstruct.t -> (unit, write_error) result Lwt.t

write flow buffer writes a buffer to the flow. There is no indication when the buffer has actually been read and, therefore, it must not be reused. The contents may be transmitted in separate packets, depending on the underlying transport. The result Ok () indicates success, Error `Closed indicates that the connection is now closed and therefore the data could not be written. Other errors are possible.

Sourceval writev : flow -> Cstruct.t list -> (unit, write_error) result Lwt.t

writev flow buffers writes a sequence of buffers to the flow. There is no indication when the buffers have actually been read and, therefore, they must not be reused. The result Ok () indicates success, Error `Closed indicates that the connection is now closed and therefore the data could not be written. Other errors are possible.

Sourceval close : flow -> unit Lwt.t

close flow flushes all pending writes and signals the remote endpoint that there will be no future writes. Once the remote endpoint has read all pending data, it is expected that calls to read on the remote return `Eof.

Note it is still possible for the remote endpoint to write to the flow and for the local endpoint to call read. This state where the local endpoint has called close but the remote endpoint has not called close is similar to that of a half-closed TCP connection or a Unix socket after shutdown(SHUTDOWN_WRITE).

close flow waits until the remote endpoint has also called close before returning. At this point no data can flow in either direction and resources associated with the flow can be freed.

Sourceval create : (module Mirage_flow.S with type flow = 'a) -> 'a -> string -> t

create (module M) t name is the flow representing t using the function defined in M.

Sourceval pp : t Fmt.t

pp is the pretty-printer for IO flows.

Sourceval forward : ?verbose:bool -> src:t -> dst:t -> unit -> unit Lwt.t

forward ?verbose ~src ~dst () forwards writes from src to dst. Block until either src or dst is closed. If verbose is set (by default it is not), show the full flow contents in the debug messages.

Sourceval proxy : ?verbose:bool -> t -> t -> unit Lwt.t

proxy ?verbose x y is the same as forward x y <*> forward y x. Block until both flows are closed. If verbose is set (by default it is not), show the full flow contents in the debug messages.