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.arpv4
- Arpv4
  - Make
    
    Clock
    
    Ethif
    
    Time
- Arpv4_packet
  - Marshal
  - Unmarshal
- Arpv4_wire
tcpip.ethif
- Ethif
  - Make
    
    N
- 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
    
    N
tcpip.ipv6
- Ipv6
  - Make
    
    Clock
    
    E
    
    R
    
    T
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Ethif
    
    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
  - Options
  - Pcb
    
    Make
    
    Clock
    
    Ip
    
    Random
    
    Time
  - 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.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 Ip : Mirage_protocols_lwt.IP

module Time : Mirage_time_lwt.S

module Clock : Mirage_clock.MCLOCK

module Random : Mirage_random.C

Signature

type t

Overall state of the TCP stack

type pcb

type error = private [>

| Mirage_protocols.Tcp.error

]

type write_error = private [>

| Mirage_protocols.Tcp.write_error

]

val pp_error : error Fmt.t

val pp_write_error : write_error Fmt.t

type connection = pcb * unit Lwt.t

State for an individual connection

val pp_pcb : Format.formatter -> pcb -> unit

val pp_stats : Format.formatter -> t -> unit

val ip : t -> Ip.t

val input : 
  t ->
  listeners:(int -> (pcb -> unit Lwt.t) option) ->
  src:Ip.ipaddr ->
  dst:Ip.ipaddr ->
  Cstruct.t ->
  unit Lwt.t

val connect : 
  t ->
  dst:Ip.ipaddr ->
  dst_port:int ->
  (connection, error) Result.result Lwt.t

val close : pcb -> unit Lwt.t

val dst : pcb -> Ip.ipaddr * int

val read : pcb -> Cstruct.t option Lwt.t

val write_available : pcb -> int

val write_wait_for : pcb -> int -> unit Lwt.t

val write : pcb -> Cstruct.t -> (unit, write_error) Result.result Lwt.t

val writev : pcb -> Cstruct.t list -> (unit, write_error) Result.result Lwt.t

val write_nodelay : pcb -> Cstruct.t -> (unit, write_error) Result.result Lwt.t

val writev_nodelay : 
  pcb ->
  Cstruct.t list ->
  (unit, write_error) Result.result Lwt.t

val create : Ip.t -> Clock.t -> t