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_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
    
    R
    
    T
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ipv4
    
    Netif
    
    Random
    
    Tcpv4
    
    Time
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
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.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
    
    IP
    
    R
- 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

Parameters

module Time : Mirage_time.S

module Random : Mirage_random.S

module Netif : Mirage_net.S

module Ethernet : Mirage_protocols.ETHERNET

module Arpv4 : Mirage_protocols.ARP

module Ipv4 : Mirage_protocols.IP with type ipaddr = Ipaddr.V4.t

module Icmpv4 : Mirage_protocols.ICMP with type ipaddr = Ipaddr.V4.t

module Udpv4 : UDPV4_DIRECT

module Tcpv4 : TCPV4_DIRECT

Signature

include Mirage_stack.V4
  with module IPV4 = Ipv4
   and module TCPV4 = Tcpv4
   and module UDPV4 = Udpv4

type t

The type representing the internal state of the IPv4 stack.

val disconnect : t -> unit Lwt.t

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

module UDPV4 = Udpv4

module TCPV4 = Tcpv4

module IPV4 = Ipv4

val udpv4 : t -> UDPV4.t

udpv4 t obtains a descriptor for use with the UDPV4 module, usually to transmit traffic.

val tcpv4 : t -> TCPV4.t

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

val ipv4 : t -> IPV4.t

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

val listen_udpv4 : t -> port:int -> UDPV4.callback -> unit

listen_udpv4 t ~port cb registers the cb callback on the UDPv4 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 UDPV4.listen instead (since mirage-protocols 6.0.0).

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

listen_tcpv4 ~keepalive t ~port cb registers the cb callback on the TCPv4 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 TCPV4.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 ->
  Arpv4.t ->
  Ipv4.t ->
  Icmpv4.t ->
  Udpv4.t ->
  Tcpv4.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 (e.g. ARP) are functioning, so that if the user wishes to establish outbound connections, they will be able to do so.