package mirage-flow-lwt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Flow-related devices using lwt

mirage-flow-lwt
- Mirage_flow_lwt
  - ABSTRACT
  - CONCRETE
  - Concrete
    
    S
  - Copy
    
    A
    
    B
    
    Clock
  - F
  - Proxy
    
    A
    
    B
    
    Clock
  - S
  - SHUTDOWNABLE

Legend:
Library
Module
Module type
Parameter
Class
Class type

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

Release v1.5.0

module type S =
  Mirage_flow.S with type 'a io = 'a Lwt.t and type buffer = Cstruct.t

module type ABSTRACT =
  Mirage_flow.ABSTRACT with type 'a io = 'a Lwt.t and type buffer = Cstruct.t

module type CONCRETE =
  Mirage_flow.CONCRETE with type 'a io = 'a Lwt.t and type buffer = Cstruct.t

module Concrete
  (S : S) : 
  CONCRETE with type buffer = S.buffer and type flow = S.flow

module type SHUTDOWNABLE =
  Mirage_flow.SHUTDOWNABLE
    with type 'a io = 'a Lwt.t
     and type buffer = Cstruct.t

module Copy (Clock : Mirage_clock.MCLOCK) (A : S) (B : S) : sig ... end

module Proxy
  (Clock : Mirage_clock.MCLOCK)
  (A : SHUTDOWNABLE)
  (B : SHUTDOWNABLE) : 
  sig ... end

module F : sig ... end

In-memory, function-based flows.

type t

The type for first-class flows.

include S with type flow = t

type 'a io = 'a Lwt.t

The type for potentially blocking I/O operations.

type error

The type for flow errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

type write_error = private [>

| Mirage_flow.write_error

]

The type for write errors.

val pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

type buffer = Cstruct.t

The type for memory buffer.

type flow = t

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

val read : flow -> (buffer Mirage_flow.or_eof, error) Pervasives.result io

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 -> buffer -> (unit, write_error) Pervasives.result io

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.

val writev : flow -> buffer list -> (unit, write_error) Pervasives.result io

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.

val close : flow -> unit io

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.

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

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

val pp : t Fmt.t

pp is the pretty-printer for IO flows.

val forward : ?verbose:bool -> src:t -> dst:t -> 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.

val 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.

package mirage-flow-lwt

Flow-related devices using lwt