package mirage-stack

  1. Overview
  2. Docs

Module type Mirage_stack.V4Source

Sourcetype t

The type representing the internal state of the IPv4 stack.

Sourceval disconnect : t -> unit Lwt.t

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

Sourceval udpv4 : t -> UDPV4.t

udpv4 t obtains a descriptor for use with the UDPV4 module, usually to transmit traffic.

Sourceval tcpv4 : t -> TCPV4.t

tcpv4 t obtains a descriptor for use with the TCPV4 module, usually to initiate outgoing connections.

Sourceval ipv4 : t -> IPV4.t

ipv4 t obtains a descriptor for use with the IPV4 module, which can handle raw IPv4 frames, or manipulate IP address configuration on the stack interface.

Sourceval listen_udpv4 : t -> port:int -> UDPV4.callback -> unit

listen_udpv4 t ~port cb registers the cb callback on the UDPv4 port and immediately return. If port is invalid (not between 0 and 65535 inclusive), it raises Invalid_argument. Multiple bindings to the same port will overwrite previous bindings, so callbacks will not chain if ports clash.

  • deprecated use UDPV4.listen instead (since mirage-protocols 6.0.0).
Sourceval listen_tcpv4 : ?keepalive:Mirage_protocols.Keepalive.t -> t -> port:int -> (TCPV4.flow -> unit Lwt.t) -> unit

listen_tcpv4 ~keepalive t ~port cb registers the cb callback on the TCPv4 port and immediately return. If port is invalid (not between 0 and 65535 inclusive), it raises Invalid_argument. Multiple bindings to the same port will overwrite previous bindings, so callbacks will not chain if ports clash. If ~keepalive is provided then these keepalive settings will be applied to the accepted connections before the callback is called.

  • deprecated use TCPV4.listen instead (since mirage-protocols 6.0.0).
Sourceval listen : t -> unit Lwt.t

listen t requests that the stack listen for traffic on the network interface associated with the stack, and demultiplex traffic to the appropriate callbacks.