On This Page
package mirage-flow-combinators
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Flow-related devices using lwt
This module define flow-related devices for MirageOS, using lwt for I/O.
Release v4.0.0
module 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.
module Copy
(Clock : Mirage_clock.MCLOCK)
(A : Mirage_flow.S)
(B : Mirage_flow.S) :
sig ... endmodule Proxy
(Clock : Mirage_clock.MCLOCK)
(A : Mirage_flow.S)
(B : Mirage_flow.S) :
sig ... endmodule F : sig ... endIn-memory, function-based flows.
include Mirage_flow.S with type flow = t
The type for write errors.
val pp_write_error : write_error Fmt.tpp_write_error is the pretty-printer for write errors.
type flow = tThe 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.
val write : flow -> Cstruct.t -> (unit, write_error) result Lwt.twrite 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.
val writev : flow -> Cstruct.t list -> (unit, write_error) result Lwt.twritev 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.
shutdown flow mode shuts down the flow for the specific mode: A flow which is shutdown `read (or `read_write will never be read again (future calls will return `Eof); a flow which is shutdown `write (or `read_write) flushes all pending writes and signals the remote endpoint there won't be any future write. In TCP, a FIN is sent.
val create : (module Mirage_flow.S with type flow = 'a) -> 'a -> string -> tcreate (module M) t name is the flow representing t using the function defined in M.
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.
On This Page