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
    
    V4V6
    
    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_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    A
    
    Log
- Static_ipv4
  - Make
    
    A
    
    E
tcpip.ipv6
- Ipv6
  - Make
    
    E
    
    N
    
    T
- Ipv6_wire
  - Icmpv6
  - Llopt
  - Na
  - Ns
  - Opt
  - Opt_prefix
  - Pingv6
  - Ra
  - Redirect
  - Rs
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Netif
    
    Tcp
    
    Time
    
    Udp
  - TCPV4V6
    
    S
    
    IP
    
    TCP
    
    UDP
tcpip.stack-socket
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    T
    
    Immediate
    
    M
  - Flow
    
    Make
    
    IP
    
    TM
  - Keepalive
    
    Make
    
    T
  - Options
  - Segment
    
    Rx
    
    ACK
    
    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.tcpv4v6-socket
- Tcp_socket
- Tcpv4v6_socket
tcpip.udp
- Udp
  - Make
    
    IP
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4v6-socket
- Udpv4v6_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 Arpv4 : Arp.S

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

module Icmpv4 : Icmpv4.S

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

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

Signature

include Tcpip.Stack.V4V6
  with module IP = Ip
   and module TCP = Tcp
   and module UDP = Udp

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 = Udp

module TCP = Tcp

module IP = Ip

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 : 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 ->
  Arpv4.t ->
  Ip.t ->
  Icmpv4.t ->
  Udp.t ->
  Tcp.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.