package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

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
    
    C
    
    E
tcpip.ipv6
- Ipv6
  - Make
    
    Clock
    
    E
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - Make
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ipv4
    
    Tcpv4
    
    Udpv4
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Tcp
    
    Udp
  - MakeV6
    
    Ethernet
    
    Ipv6
    
    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
    
    C
    
    IP
  - Keepalive
    
    Make
    
    Clock
  - Options
  - Segment
    
    Rx
    
    Tx
    
    Clock
  - Sequence
  - State
    
    Make
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
  - User_buffer
    
    Rx
    
    Tx
    
    Clock
    
    TXS
  - Window
    
    Make
    
    C
  - 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
- 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

include Mirage_protocols.TCP
  with type ipaddr = Ipaddr.V6.t
   and type flow = Lwt_unix.file_descr
   and type error = [ Mirage_protocols.Tcp.error | `Exn of exn ]
   and type write_error = [ Mirage_protocols.Tcp.write_error | `Exn of exn ]

type error = [

| Mirage_protocols.Tcp.error
| `Exn of exn

]

The type for TCP errors.

type write_error = [

| Mirage_protocols.Tcp.write_error
| `Exn of exn

]

The type for TCP write errors.

type ipaddr = Ipaddr.V6.t

The type for IP address representations.

type flow = Lwt_unix.file_descr

A flow represents the state of a single TCP stream that is connected to an endpoint.

type t

The type representing the internal state of the TCP layer.

include Mirage_flow.S
  with type flow := flow
   and type error := error
   and type write_error := write_error

val pp_error : error Fmt.t

val pp_write_error : write_error Fmt.t

val read : flow -> (Cstruct.t Mirage_flow.or_eof, error) Stdlib.result Lwt.t

val write : flow -> Cstruct.t -> (unit, write_error) Stdlib.result Lwt.t

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

val close : flow -> unit Lwt.t

val dst : flow -> ipaddr * int

Get the destination IP address and destination port that a flow is currently connected to.

val write_nodelay : 
  flow ->
  Cstruct.t ->
  (unit, write_error) Stdlib.result Lwt.t

write_nodelay flow buffer writes the contents of buffer to the flow. The thread blocks until all data has been successfully transmitted to the remote endpoint. Buffering within the layer is minimized in this mode. Note that this API will change in a future revision to be a per-flow attribute instead of a separately exposed function.

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

writev_nodelay flow buffers writes the contents of buffers to the flow. The thread blocks until all data has been successfully transmitted to the remote endpoint. Buffering within the layer is minimized in this mode. Note that this API will change in a future revision to be a per-flow attribute instead of a separately exposed function.

val create_connection : 
  ?keepalive:Mirage_protocols.Keepalive.t ->
  t ->
  (ipaddr * int) ->
  (flow, error) Stdlib.result Lwt.t

create_connection ~keepalive t (addr,port) opens a TCP connection to the specified endpoint.

If the optional argument ?keepalive is provided then TCP keep-alive messages will be sent to the server when the connection is idle. If no responses are received then eventually the connection will be disconnected: read will return Ok `Eof and write will return Error `Closed

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

listen t ~port ~keepalive callback listens on port. The callback is executed for each flow that was established. If keepalive is provided, this configuration will be applied before calling callback.

raises Invalid_argument
if port < 0 or port > 65535

val unlisten : t -> port:int -> unit

unlisten t ~port stops any listener on port.

val input : t -> src:ipaddr -> dst:ipaddr -> Cstruct.t -> unit Lwt.t

input t returns an input function continuation to be passed to the underlying IP layer.

val connect : Ipaddr.V6.Prefix.t option -> t Lwt.t

val disconnect : t -> unit Lwt.t

val set_switched_off : t -> unit Lwt.t -> unit