Static_ipv4.Make.E · tcpip 5.0.1 · OCaml Packages

tcpip

OCaml TCP/IP networking stack, used in MirageOS

icmpv4_socket
- Icmpv4_socket
tcp
- Tcp
  - Ack
    
    Delayed
    
    1-T
    
    Immediate
    
    M
  - Flow
    
    Make
    
    1-IP
    
    2-TM
    
    3-C
    
    4-R
  - Keepalive
    
    Make
    
    1-T
    
    2-Clock
  - Options
  - Segment
    
    Rx
    
    1-T
    
    Tx
    
    1-Time
    
    2-Clock
  - Sequence
  - State
    
    Make
    
    1-Time
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
    
    1-T
  - User_buffer
    
    Rx
    
    Tx
    
    1-Time
    
    2-Clock
    
    TXS
  - Window
    
    Make
    
    1-C
  - Wire
    
    Make
    
    1-Ip
tcp_socket_options
- Tcp_socket_options
tcpip
- Tcpip_checksum
tcpip_icmpv4
- Icmpv4
  - Make
    
    1-I
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip_ipv4
- Fragments
  - Cache
  - K
  - V
- Ipv4_common
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    1-Log
    
    2-A
- Static_ipv4
  - Make
    
    1-R
    
    2-C
    
    3-E
    
    4-A
tcpip_ipv6
- Ipv6
  - Make
    
    1-E
    
    2-R
    
    3-T
    
    4-Clock
- Ipv6_wire
- Ndpv6
tcpip_stack_direct
- Tcpip_stack_direct
  - Make
    
    1-Time
    
    2-Random
    
    3-Netif
    
    4-Ethernet
    
    5-Arpv4
    
    6-Ipv4
    
    7-Icmpv4
    
    8-Udpv4
    
    9-Tcpv4
  - MakeV6
    
    1-Time
    
    2-Random
    
    3-Netif
    
    4-Ethernet
    
    5-Ipv6
    
    6-Udpv6
    
    7-Tcpv6
  - TCPV4_DIRECT
  - TCPV6_DIRECT
  - UDPV4_DIRECT
  - UDPV6_DIRECT
tcpip_stack_socket
tcpip_udpv4
- Udp
  - Make
    
    1-IP
    
    2-R
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip_unix
- Tcpip_unix
tcpip_xen
- Tcpip_xen
tcpv4_socket
- Tcp_socket
- Tcpv4_socket
tcpv6_socket
- Tcpv6_socket
udpv4_socket
- Udpv4_socket
udpv6_socket
- Udpv6_socket

Legend:
Library
Module
Module type
Parameter
Class
Class type

Library tcpip_ipv4

Parameter #3 Static_ipv4 . Make . E

type error#row

The type for ethernet interface errors.

and error = private [>

| Mirage_protocols.Ethernet.error

]

The type for ethernet interface errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

include Mirage_device.S

type t

The type representing the internal state of the device

val disconnect : t -> unit Lwt.t

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

val write : 
  t ->
  ?src:Macaddr.t ->
  Macaddr.t ->
  Mirage_protocols.Ethernet.proto ->
  ?size:int ->
  ( Cstruct.t -> int ) ->
  ( unit, error ) result Lwt.t

write eth ~src dst proto ~size payload outputs an ethernet frame which header is filled by eth, and its payload is the buffer from the call to payload. Payload gets a buffer of size (defaults to mtu) to fill with their payload. If size exceeds mtu, an error is returned.

val mac : t -> Macaddr.t

mac eth is the MAC address of eth.

val mtu : t -> int

mtu eth is the Maximum Transmission Unit of the eth i.e. the maximum size of the payload, excluding the ethernet frame header.

val input : 
  arpv4:( Cstruct.t -> unit Lwt.t ) ->
  ipv4:( Cstruct.t -> unit Lwt.t ) ->
  ipv6:( Cstruct.t -> unit Lwt.t ) ->
  t ->
  Cstruct.t ->
  unit Lwt.t

input ~arpv4 ~ipv4 ~ipv6 eth buffer decodes the buffer and demultiplexes it depending on the protocol to the callback.