package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Tcpip_checksum
tcpip.icmpv4
- Icmpv4
  - Make
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip.icmpv4-socket
- Icmpv4_socket
tcpip.ipv4
- Fragments
  - Cache
  - K
  - V
- Ipv4_common
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
- Static_ipv4
  - Make
tcpip.ipv6
- Ipv6
  - Make
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
  - Make
    
    IPV4
    
    TCPV4
    
    UDPV4
  - MakeV4V6
    
    IP
    
    TCP
    
    UDP
  - MakeV6
    
    IP
    
    TCP
    
    UDP
tcpip.stack-socket
- Ipv4_socket
- Ipv4v6_socket
- Ipv6_socket
- Tcpip_stack_socket
  - V4
    
    IPV4
    
    TCPV4
    
    UDPV4
    
    Log
  - V4V6
    
    IP
    
    TCP
    
    UDP
    
    Log
  - V6
    
    IP
    
    TCP
    
    UDP
    
    Log
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    Immediate
    
    M
  - Flow
    
    Make
  - 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
tcpip.tcp_socket_options
- Tcp_socket_options
tcpip.tcpv4-socket
- Tcp_socket
- Tcpv4_socket
tcpip.tcpv4v6-socket
- Tcpv4v6_socket
tcpip.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv4v6-socket
- Udpv4v6_socket
tcpip.udpv6-socket
- Udpv6_socket
tcpip.unix
- Tcpip_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Mirage_protocols.ICMP with type ipaddr = Ipaddr.V4.t

type t

val disconnect : t -> unit Lwt.t

type ipaddr = Ipaddr.V4.t

type error

val pp_error : error Fmt.t

val input : t -> src:ipaddr -> dst:ipaddr -> Cstruct.t -> unit Lwt.t

val write : 
  t ->
  ?src:ipaddr ->
  dst:ipaddr ->
  ?ttl:int ->
  Cstruct.t ->
  (unit, error) Stdlib.result Lwt.t

val connect : unit -> t Lwt.t

val listen : t -> ipaddr -> (Cstruct.t -> unit Lwt.t) -> unit Lwt.t

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.