package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

tcpip
- Tcpip_checksum
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
- 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
    
    A
    
    Log
- Static_ipv4
  - Make
    
    A
    
    C
    
    E
    
    R
tcpip.ipv6
- Ipv6
  - Make
    
    Clock
    
    E
    
    N
    
    R
    
    T
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - Make
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ipv4
    
    Netif
    
    Random
    
    Tcpv4
    
    Time
    
    Udpv4
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Netif
    
    Random
    
    Tcp
    
    Time
    
    Udp
  - MakeV6
    
    Ethernet
    
    Ipv6
    
    Netif
    
    Random
    
    Tcpv6
    
    Time
    
    Udpv6
  - TCPV4V6_DIRECT
  - TCPV4_DIRECT
  - TCPV6_DIRECT
  - UDPV4V6_DIRECT
  - UDPV4_DIRECT
  - UDPV6_DIRECT
tcpip.stack-socket
- Ipv4_socket
- Ipv4v6_socket
- Ipv6_socket
- Tcpip_stack_socket
  - V4
  - V4V6
  - V6
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    T
    
    Immediate
    
    M
  - Flow
    
    Make
    
    C
    
    IP
    
    R
    
    TM
  - Keepalive
    
    Make
    
    Clock
    
    T
  - Options
  - Segment
    
    Rx
    
    T
    
    Tx
    
    Clock
    
    Time
  - Sequence
  - State
    
    Make
    
    Time
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
    
    T
  - User_buffer
    
    Rx
    
    Tx
    
    Clock
    
    TXS
    
    Time
  - Window
    
    Make
    
    C
  - Wire
    
    Make
    
    Ip
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
    
    IP
    
    R
- 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_stack.V4V6
  with module UDP = Udpv4v6_socket
   and module TCP = Tcpv4v6_socket
   and module IP = Ipv4v6_socket

type t

The type representing the internal state of the dual IPv4 and IPv6 stack.

val disconnect : t -> unit Lwt.t

Disconnect from the dual IPv4 and IPv6 stack. While this might take some time to complete, it can never result in an error.

module UDP = Udpv4v6_socket

module TCP = Tcpv4v6_socket

module IP = Ipv4v6_socket

val udp : t -> UDP.t

udp t obtains a descriptor for use with the UDP module, usually to transmit traffic.

val tcp : t -> TCP.t

tcp t obtains a descriptor for use with the TCP module, usually to initiate outgoing connections.

val ip : t -> IP.t

ip t obtains a descriptor for use with the IP module, which can handle raw IPv4 and IPv6 frames, or manipulate IP address configuration on the stack interface.

val listen_udp : t -> port:int -> UDP.callback -> unit

listen_udp t ~port cb registers the cb callback on the UDP port and immediately return. If port is invalid (not between 0 and 65535 inclusive), it raises Invalid_argument. Multiple bindings to the same port will overwrite previous bindings, so callbacks will not chain if ports clash.

deprecated use UDP.listen instead (since mirage-protocols 6.0.0).

val listen_tcp : 
  ?keepalive:Mirage_protocols.Keepalive.t ->
  t ->
  port:int ->
  (TCP.flow -> unit Lwt.t) ->
  unit

listen_tcp ~keepalive t ~port cb registers the cb callback on the TCP port and immediately return. If port is invalid (not between 0 and 65535 inclusive), it raises Invalid_argument. Multiple bindings to the same port will overwrite previous bindings, so callbacks will not chain if ports clash. If ~keepalive is provided then these keepalive settings will be applied to the accepted connections before the callback is called.

deprecated use TCP.listen instead (since mirage-protocols 6.0.0).

val listen : t -> unit Lwt.t

listen t requests that the stack listen for traffic on the network interface associated with the stack, and demultiplex traffic to the appropriate callbacks.

val connect : Udpv4v6_socket.t -> Tcpv4v6_socket.t -> t Lwt.t