package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

tcpip
- Tcpip_checksum
tcpip.arpv4
- Arpv4
  - Make
    
    Ethif
- Arpv4_packet
  - Marshal
  - Unmarshal
- Arpv4_wire
tcpip.ethif
- Ethif
  - Make
- Ethif_packet
  - Marshal
  - Unmarshal
- Ethif_wire
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip.icmpv4-socket
- Icmpv4_socket
tcpip.ipv4
- Ipv4_common
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    A
    
    Log
- Static_ipv4
  - Make
    
    A
    
    E
tcpip.ipv6
- Ipv6
  - Make
    
    E
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Ethif
    
    Icmpv4
    
    Ipv4
    
    Tcpv4
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    Immediate
    
    M
  - Flow
    
    Make
    
    IP
  - 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
    
    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
- 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

include Mirage_stack_lwt.V4
  with type tcpv4 = Tcpv4_socket.t
   and type udpv4 = Udpv4_socket.t
   and type ipv4 = Ipaddr.V4.t option
   and module UDPV4 = Udpv4_socket
   and module TCPV4 = Tcpv4_socket
   and module IPV4 = Ipv4_socket

include Mirage_stack.V4
  with type 'a io = 'a Lwt.t
   and type ipv4addr = Ipaddr.V4.t
   and type buffer = Cstruct.t
  with type tcpv4 = Tcpv4_socket.t
  with type udpv4 = Udpv4_socket.t
  with type ipv4 = Ipaddr.V4.t option
  with module UDPV4 = Udpv4_socket
  with module TCPV4 = Tcpv4_socket
  with module IPV4 = Ipv4_socket

type ipv4addr = Ipaddr.V4.t

The type for IPv4 addresses.

type buffer = Cstruct.t

The type for memory buffers.

type udpv4 = Udpv4_socket.t

The type for UDPv4 implementations.

type tcpv4 = Tcpv4_socket.t

The type for TCPv4 implementations.

type ipv4 = Ipaddr.V4.t option

The type for IPv4 implementations.

include Mirage_device.S with type 'a io = 'a Lwt.t

type 'a io = 'a Lwt.t

type t

val disconnect : t -> unit io

module UDPV4 = Udpv4_socket

module TCPV4 = Tcpv4_socket

module IPV4 = Ipv4_socket

val udpv4 : t -> udpv4

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

val tcpv4 : t -> tcpv4

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

val ipv4 : t -> ipv4

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.

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

listen_tcpv4 ~keepalive t ~port cb registers the cb callback on the TCPv4 port and immediatey 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.

val listen : t -> unit io

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 : Ipaddr.V4.t list -> Udpv4_socket.t -> Tcpv4_socket.t -> t Lwt.t