package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package tcpip

tcpip
- Tcpip
  - Ip
    
    S
  - Stack
    
    V4
    
    IPV4
    
    TCPV4
    
    UDPV4
    
    V4V6
    
    IP
    
    TCP
    
    UDP
    
    V6
    
    IP
    
    TCP
    
    UDP
  - Tcp
    
    Keepalive
    
    S
  - Udp
    
    S
tcpip.checksum
- Tcpip_checksum
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
  - S
- 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
    
    E
tcpip.ipv6
- Ipv6
  - Make
    
    E
    
    N
    
    T
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - Make
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ipv4
    
    Netif
    
    Tcpv4
    
    Time
    
    Udpv4
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Netif
    
    Tcp
    
    Time
    
    Udp
  - MakeV6
    
    Ethernet
    
    Ipv6
    
    Netif
    
    Tcpv6
    
    Time
    
    Udpv6
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
    
    IP
    
    TM
  - Keepalive
    
    Make
    
    T
  - Options
  - Segment
    
    Rx
    
    T
    
    Tx
    
    Time
  - Sequence
  - State
    
    Make
    
    Time
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
    
    T
  - User_buffer
    
    Rx
    
    Tx
    
    TXS
    
    Time
  - Window
    
    Make
  - 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
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4-socket
- Udpv4_socket
  - Log
tcpip.udpv4v6-socket
- Udpv4v6_socket
  - Log
tcpip.udpv6-socket
- Udpv6_socket
  - Log

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Time : Mirage_time.S

module Random : Mirage_random.S

module Netif : Mirage_net.S

module Ethernet : Ethernet.S

module Ipv6 : Tcpip.Ip.S with type ipaddr = Ipaddr.V6.t

module Udpv6 : Tcpip.Udp.S with type ipaddr = Ipaddr.V6.t

module Tcpv6 : Tcpip.Tcp.S with type ipaddr = Ipaddr.V6.t

Signature

include Tcpip.Stack.V6
  with module IP = Ipv6
   and module TCP = Tcpv6
   and module UDP = Udpv6

type t

The type representing the internal state of the IPv6 stack.

val disconnect : t -> unit Lwt.t

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

module UDP = Udpv6

module TCP = Tcpv6

module IP = Ipv6

val udp : t -> UDP.t

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

val tcp : t -> TCP.t

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

val ip : t -> IP.t

ip t obtains a descriptor for use with the IPV6 module, which can handle raw 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 UDPv6 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:Tcpip.Tcp.Keepalive.t ->
  t ->
  port:int ->
  (TCP.flow -> unit Lwt.t) ->
  unit

listen_tcp ~keepalive t ~port cb registers the cb callback on the TCPv6 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 : Netif.t -> Ethernet.t -> Ipv6.t -> Udpv6.t -> Tcpv6.t -> t Lwt.t

connect assembles the arguments into a network stack, then calls `listen` on the assembled stack before returning it to the caller. The initial `listen` functions to ensure that the lower-level layers are functioning, so that if the user wishes to establish outbound connections, they will be able to do so.