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
- Static_ipv4
  - Make
    
    A
    
    E
    
    R
tcpip.ipv6
- Ipv6
  - Make
    
    E
    
    N
    
    R
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - Make
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ipv4
    
    Netif
    
    Random
    
    Tcpv4
    
    Udpv4
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Netif
    
    Random
    
    Tcp
    
    Udp
  - MakeV6
    
    Ethernet
    
    Ipv6
    
    Netif
    
    Random
    
    Tcpv6
    
    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
    
    Immediate
    
    M
  - Flow
    
    Make
    
    IP
    
    R
  - 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.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

Parameters

module IP : Mirage_protocols.IP

module R : Mirage_random.S

Signature

include Mirage_protocols.UDP
  with type ipaddr = IP.ipaddr
   and type ipinput = src:IP.ipaddr -> dst:IP.ipaddr -> Cstruct.t -> unit Lwt.t

type error

The type for UDP errors.

val pp_error : error Fmt.t

pp is the pretty-printer for errors.

type ipaddr = IP.ipaddr

The type for an IP address representations.

type ipinput = src:IP.ipaddr -> dst:IP.ipaddr -> Cstruct.t -> unit Lwt.t

The type for input function continuation to pass onto the underlying IP layer. This will normally be a NOOP for a conventional kernel, but a direct implementation will parse the buffer.

include Mirage_device.S

type t

val disconnect : t -> unit Lwt.t

type callback =
  src:ipaddr ->
  dst:ipaddr ->
  src_port:int ->
  Cstruct.t ->
  unit Lwt.t

The type for callback functions that adds the UDP metadata for src and dst IP addresses, the src_port of the connection and the buffer payload of the datagram.

val input : listeners:(dst_port:int -> callback option) -> t -> ipinput

input listeners t demultiplexes incoming datagrams based on their destination port. The listeners callback will either return a concrete handler or a None, which results in the datagram being dropped.

val write : 
  ?src:ipaddr ->
  ?src_port:int ->
  ?ttl:int ->
  dst:ipaddr ->
  dst_port:int ->
  t ->
  Cstruct.t ->
  (unit, error) Stdlib.result Lwt.t

write ~src ~src_port ~ttl ~dst ~dst_port udp data is a task that writes data from an optional src and src_port to a dst and dst_port IP address pair. An optional time-to-live (ttl) is passed through to the IP layer.

val connect : IP.t -> t Lwt.t