package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Tcpip_checksum
- Wire_structs
tcpip.arpv4
- Arpv4
  - Make
    
    Clock
    
    Ethif
    
    Time
- Arpv4_wire
tcpip.dhcpv4
- Dhcp_clientv4
  - Make
    
    Console
    
    Random
    
    Time
    
    Udp
- Dhcpv4_option
  - Marshal
  - Packet
  - Unmarshal
tcpip.ethif
- Ethif
  - Make
    
    N
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
- Icmpv4_parse
- Icmpv4_print
- Icmpv4_wire
tcpip.ipv4
- Ipv4
  - Make
    
    A
    
    N
    
    Routing
tcpip.ipv6
- Ipv6
  - Make
    
    C
    
    E
    
    T
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Console
    
    Ethif
    
    Icmpv4
    
    Ipv4
    
    Netif
    
    Random
    
    Tcpv4
    
    Time
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
tcpip.tcp
- Tcp
tcpip.tcpv4-socket
- Tcpv4_socket
tcpip.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
    
    IP
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv6-socket
- Udpv6_socket

Legend:
Library
Module
Module type
Parameter
Class
Class type

type buffer = Cstruct.t

The type for memory buffers.

type netif = Netif.t

The type for ethernet network interfaces.

type error = [

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

]

The type for IO operation errors.

type macaddr = Macaddr.t

The type for unique MAC identifiers.

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

type 'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t

The type representing the internal state of the device

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 : 
  arpv4:(buffer -> unit io) ->
  ipv4:(buffer -> unit io) ->
  ipv6:(buffer -> unit io) ->
  t ->
  buffer ->
  unit io

FIXME 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.