package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Tcpip_checksum
tcpip.arpv4
- Arpv4
  - Make
    
    Ethif
- Arpv4_packet
  - Marshal
  - Unmarshal
- Arpv4_wire
tcpip.ethif
- Ethif
  - Make
- Ethif_packet
  - Marshal
  - Unmarshal
- Ethif_wire
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip.icmpv4-socket
- Icmpv4_socket
tcpip.ipv4
- Ipv4_common
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    A
    
    Log
- Static_ipv4
  - Make
    
    A
    
    E
tcpip.ipv6
- Ipv6
  - Make
    
    E
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Ethif
    
    Icmpv4
    
    Ipv4
    
    Tcpv4
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    Immediate
    
    M
  - Flow
    
    Make
    
    IP
  - Keepalive
    
    Make
  - Options
  - Segment
    
    Rx
    
    Tx
  - Sequence
  - State
    
    Make
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
  - User_buffer
    
    Rx
    
    Tx
    
    TXS
  - Window
    
    Make
  - Wire
    
    Make
    
    Ip
tcpip.tcp_socket_options
- Tcp_socket_options
tcpip.tcpv4-socket
- Tcp_socket
- Tcpv4_socket
tcpip.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
    
    IP
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv6-socket
- Udpv6_socket
tcpip.unix
- Tcpip_unix
tcpip.xen
- Tcpip_xen

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Mirage_protocols_lwt.ICMPV4

include Mirage_device.S with type 'a io = 'a Lwt.t

type 'a io = 'a Lwt.t

type t

val disconnect : t -> unit io

type ipaddr = Ipaddr.V4.t

The type for IP addresses.

type buffer = Cstruct.t

The type for buffers.

type error

The type for ICMP errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

val input : t -> src:ipaddr -> dst:ipaddr -> buffer -> unit io

input t src dst buffer reacts to the ICMP message in buffer.

val write : t -> dst:ipaddr -> buffer -> (unit, error) Stdlib.result io

write t dst buffer sends the ICMP message in buffer to dst over IP.

val connect : unit -> t io

val listen : t -> ipaddr -> (buffer -> unit io) -> unit io

listen t addr fn attempts to create an unprivileged listener on IP address addr.

When a packet is received, the callback fn will be called in a fresh background thread. The callback will be provided a buffer containing an IP datagram with an ICMP payload inside.

The thread returned by listen blocks until the stack is disconnected.