package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Wire_structs
  - Tcp_wire
tcpip.channel
- Channel
  - Make
    
    F
tcpip.dhcpv4
- Dhcp_clientv4
  - Make
    
    Console
    
    Ethif
    
    Ipv4
    
    Random
    
    Time
    
    Udp
- Dhcpv4_option
  - Marshal
  - Packet
  - Unmarshal
tcpip.ethif
- Arpv4
- Ethif
  - Make
    
    N
- Tcpip_checksum
tcpip.ethif-unix
- Ethif_unix
tcpip.ipv4
- Ipv4
  - Make
    
    N
- Tcpip_checksum
tcpip.ipv4-unix
- Ipv4_unix
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Console
    
    Ethif
    
    IPV4
    
    Ipv4
    
    Netif
    
    Random
    
    TCPV4
    
    Tcpv4
    
    Time
    
    UDPV4
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
- Ipv4_socket
- Tcpip_stack_socket
  - Make
    
    Console
    
    IPV4
    
    TCPV4
    
    UDPV4
tcpip.stack-unix
- Tcpip_stack_unix
  - IPV4
  - TCPV4
  - UDPV4
tcpip.tcpv4
- Tcpv4
  - Ack
    
    Delayed
    
    T
    
    Immediate
    
    M
  - Flow
    
    Make
    
    C
    
    IP
    
    R
    
    TM
  - Options
  - Pcb
    
    Make
    
    Clock
    
    Ipv4
    
    Random
    
    Time
  - Segment
    
    Rx
    
    T
    
    Tx
    
    Clock
    
    Time
  - Sequence
  - Sliding_window
  - State
    
    Make
    
    Time
  - Tcptimer
    
    Make
    
    T
  - User_buffer
    
    Rx
    
    Tx
    
    Clock
    
    TXS
    
    Time
  - Window
    
    Make
    
    C
  - Wire
    
    Make
    
    Ipv4
tcpip.tcpv4-socket
- Tcpv4_socket
tcpip.tcpv4-unix
- Tcpv4_unix
  - Channel
  - Flow
tcpip.udpv4
- Udpv4
  - Make
    
    IP
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv4-unix
- Udpv4_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

An Ethernet stack that parses frames from a network device and can associate them with IP address via ARP.

type buffer = Cstruct.t

Abstract type for a memory buffer that may not be page aligned

type netif

Abstract type for an Ethernet network interface.

type ipv4addr = Ipaddr.V4.t

Abstract type for an IPv4 address representation.

type error = [

| `Unknown of string
(*
an undiagnosed error
*)
| `Unimplemented
(*
operation not yet implemented in the code
*)
| `Disconnected
(*
the device has been previously disconnected
*)

]

IO operation errors

type macaddr = Macaddr.t

Unique MAC identifier for the device

include V1.DEVICE
  with type error := error
   and type id := netif
  with type 'a io = 'a Lwt.t

type 'a io = 'a Lwt.t

A potentially blocking I/O operation

type t

The type representing the internal state of the device

val id : t -> netif

Return the identifier that was used to construct this device

val connect : netif -> [ `Error of error | `Ok of t ] io

Connect to the device identified by id

val disconnect : t -> unit io

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

val write : t -> buffer -> unit io

write nf buf outputs buf to netfront nf.

val writev : t -> buffer list -> unit io

writev nf bufs output a list of buffers to netfront nf as a single packet.

val mac : t -> macaddr

mac nf is the MAC address of nf.

val input : 
  ipv4:(buffer -> unit io) ->
  ipv6:(buffer -> unit io) ->
  t ->
  buffer ->
  unit io

listen nf fn is a blocking operation that calls fn buf with every packet that is read from the interface. It returns as soon as it has initialised, and the function can be stopped by calling disconnect in the device layer.

val query_arpv4 : t -> ipv4addr -> macaddr io

Query the association from an IPV4 address to a MAC address. TODO: clarify if this task is guaranteed to be cancelable or not.

val add_ipv4 : t -> ipv4addr -> unit io

Bind an IPv4 address to this interface, to be used when replying to ARPv4 requests.