Ethif_packet.Marshal · tcpip 3.6.0

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_arpv4
- Arpv4
  - Make
    
    1-Ethif
    
    2-Clock
    
    3-Time
- Arpv4_packet
  - Marshal
  - Unmarshal
- Arpv4_wire
tcpip_ethif
- Ethif
  - Make
    
    1-N
- Ethif_packet
  - Marshal
  - Unmarshal
- Ethif_wire
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-Ethif
    
    5-Arpv4
    
    6-Ipv4
    
    7-Icmpv4
    
    8-Udpv4
    
    9-Tcpv4
  - TCPV4_DIRECT
  - UDPV4_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_ethif

val into_cstruct : t -> Cstruct.t -> ( unit, error ) result

into_cstruct t buf writes a 14-byte ethernet header representing t.ethertype, t.src_mac, and t.dst_mac to buf at offset 0. Returns Ok () on success and Error error on failure. Currently, the only possibility for failure is a buf too small to contain the header; to avoid this, provide a buffer of size at least 14.

val make_cstruct : t -> Cstruct.t

given a t, construct and return an Ethernet header representing t.ethertype, t.source, and t.destination. make_cstruct will allocate a new 14 bytes for the Ethernet header it returns.