mirage-protocols 7.0.0 · OCaml Package

Transmission Control Protocol layer: reliable ordered streaming communication.

type error = private [>

| Tcp.error

]

The type for TCP errors.

type write_error = private [>

| Tcp.write_error

]

The type for TCP write errors.

type ipaddr

The type for IP address representations.

type flow

A flow represents the state of a single TCP stream that is connected to an endpoint.

type t

The type representing the internal state of the TCP layer.

val disconnect : t -> unit Lwt.t

Disconnect from the TCP layer. While this might take some time to complete, it can never result in an error.

include Mirage_flow.S
  with type flow := flow
   and type error := error
   and type write_error := write_error

val pp_error : error Fmt.t

val pp_write_error : write_error Fmt.t

val read : flow -> (Cstruct.t Mirage_flow.or_eof, error) Stdlib.result Lwt.t

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

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

val close : flow -> unit Lwt.t

val dst : flow -> ipaddr * int

Get the destination IP address and destination port that a flow is currently connected to.

val write_nodelay : 
  flow ->
  Cstruct.t ->
  (unit, write_error) Stdlib.result Lwt.t

write_nodelay flow buffer writes the contents of buffer to the flow. The thread blocks until all data has been successfully transmitted to the remote endpoint. Buffering within the layer is minimized in this mode. Note that this API will change in a future revision to be a per-flow attribute instead of a separately exposed function.

val writev_nodelay : 
  flow ->
  Cstruct.t list ->
  (unit, write_error) Stdlib.result Lwt.t

writev_nodelay flow buffers writes the contents of buffers to the flow. The thread blocks until all data has been successfully transmitted to the remote endpoint. Buffering within the layer is minimized in this mode. Note that this API will change in a future revision to be a per-flow attribute instead of a separately exposed function.

val create_connection : 
  ?keepalive:Keepalive.t ->
  t ->
  (ipaddr * int) ->
  (flow, error) Stdlib.result Lwt.t

create_connection ~keepalive t (addr,port) opens a TCP connection to the specified endpoint.

If the optional argument ?keepalive is provided then TCP keep-alive messages will be sent to the server when the connection is idle. If no responses are received then eventually the connection will be disconnected: read will return Ok `Eof and write will return Error `Closed

val listen : 
  t ->
  port:int ->
  ?keepalive:Keepalive.t ->
  (flow -> unit Lwt.t) ->
  unit

listen t ~port ~keepalive callback listens on port. The callback is executed for each flow that was established. If keepalive is provided, this configuration will be applied before calling callback.

raises Invalid_argument
if port < 0 or port > 65535

val unlisten : t -> port:int -> unit

unlisten t ~port stops any listener on port.

val input : t -> src:ipaddr -> dst:ipaddr -> Cstruct.t -> unit Lwt.t

input t returns an input function continuation to be passed to the underlying IP layer.

package mirage-protocols