mirage-protocols 2.0.0 · OCaml Package

A TCP stack that can send and receive reliable streams using the TCP protocol.

type error = private [>

| Tcp.error

]

The type for TCP errors.

type write_error = private [>

| Tcp.write_error

]

The type for TCP write errors.

type buffer

The type for memory buffers.

type ipaddr

The type for IP address representations.

type ipinput

The type for input function continuation to pass onto the underlying IP stack. This will normally be a NOOP for a conventional kernel, but a direct implementation will parse the buffer.

type flow

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

include Mirage_device.S

type +'a io

type t

val disconnect : t -> unit io

include Mirage_flow.S
  with type 'a io := 'a io
   and type buffer := buffer
   and 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 -> (buffer Mirage_flow.or_eof, error) Stdlib.result io

val write : flow -> buffer -> (unit, write_error) Stdlib.result io

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

val close : flow -> unit io

val dst : flow -> ipaddr * int

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

val write_nodelay : flow -> buffer -> (unit, write_error) Stdlib.result io

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

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 stack 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 io

create_connection ~keepalive t (addr,port) opens a TCPv4 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

type listener = {

process : flow -> unit io;
(*
process a connected flow
*)
keepalive : Keepalive.t option;
(*
optional TCP keepalive configuration
*)

}

A TCP listener on a particular port

val input : t -> listeners:(int -> listener option) -> ipinput

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

When the stack receives a TCP SYN (i.e. a connection request) to a particular port, it will evaluate listeners port:

If listeners port is None, the input function will return an RST to refuse the connection.
If listeners port is Some listener then the connection will be accepted and the resulting flow will be processed by listener.process. If listener.keepalive is Some configuration then the TCP keep-alive configuration will be applied before calling listener.process.

package mirage-protocols