mirage-types 2.8.0 · OCaml Package

TCP/IPv4 stack

A complete TCP/IPv4 stack that can be used by applications to receive and transmit network traffic.

type console

The type for console logger.

type netif

The type for network interface that is used to transmit and receive traffic associated with this stack.

type mode

The type for configuration modes associated with this interface. These can consist of the IPv4 address binding, or a DHCP interface.

type ('console, 'netif, 'mode) config

The type for the collection of user configuration specified to construct a stack.

type ipv4addr

The type for IPv4 addresses.

type buffer

The type for memory buffers.

type udpv4

The type for UDPv4 stacks.

type tcpv4

The type for TCPv4 stacks.

type ipv4

The type for IPv4 stacks.

type error = [

| `Unknown of string

]

The type for I/O operation errors.

include DEVICE
  with type error := error
   and type id = (console, netif, mode) config

type +'a io

The type for potentially blocking I/O operation

type t

The type representing the internal state of the device

type id = (console, netif, mode) config

This type is no longer used and will be removed once other * modules stop using it in their type signatures.

val disconnect : t -> unit io

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

module UDPV4 : 
  UDP
    with type +'a io = 'a io
     and type ipaddr = ipv4addr
     and type buffer = buffer
     and type t = udpv4
     and type ip = ipv4

module TCPV4 : 
  TCP
    with type +'a io = 'a io
     and type ipaddr = ipv4addr
     and type buffer = buffer
     and type t = tcpv4
     and type ip = ipv4

module IPV4 : 
  IPV4
    with type +'a io = 'a io
     and type ipaddr = ipv4addr
     and type buffer = buffer
     and type t = ipv4

val udpv4 : t -> udpv4

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

val tcpv4 : t -> tcpv4

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

val ipv4 : t -> ipv4

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.

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

listen_udpv4 t ~port cb will register 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.

val listen_tcpv4 : t -> port:int -> TCPV4.callback -> unit

listen_tcpv4 t ~port cb will register the cb callback on the TCPv4 port and immediatey 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.

val listen : t -> unit io

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

package mirage-types

TCP/IPv4 stack