package tcpip

  1. Overview
  2. Docs
OCaml TCP/IP networking stack, used in MirageOS

Install

dune-project
 Dependency

Authors

Maintainers

Sources

tcpip-v6.4.0.tbz
sha256=6e32bf540d291e9b7325cb3dd00df2f695533e009c46ea534d5518b9492c7348
sha512=2e9f9ca2eeac637599eb48e087b4632598539f1c76f9251758995c7eedeb723f8b951d557a2a53b85a58d50a04e68e15598581f88fca8997733e800fcfca422b

doc/tcpip.stack-socket/Tcpip_stack_socket/V6/index.html

Module Tcpip_stack_socket.V6Source

include Mirage_stack.V6 with module UDP = Udpv6_socket and module TCP = Tcpv6_socket and module IP = Ipv6_socket
Sourcetype t

The type representing the internal state of the IPv6 stack.

Sourceval disconnect : t -> unit Lwt.t

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

Sourcemodule UDP = Udpv6_socket
Sourcemodule TCP = Tcpv6_socket
Sourcemodule IP = Ipv6_socket
Sourceval udp : t -> UDP.t

udp t obtains a descriptor for use with the UDPV6 module, usually to transmit traffic.

Sourceval tcp : t -> TCP.t

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

Sourceval ip : t -> IP.t

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

Sourceval listen_udp : t -> port:int -> UDP.callback -> unit

listen_udp t ~port cb registers the cb callback on the UDPv6 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 UDP.listen instead (since mirage-protocols 6.0.0).
Sourceval listen_tcp : ?keepalive:Mirage_protocols.Keepalive.t -> t -> port:int -> (TCP.flow -> unit Lwt.t) -> unit

listen_tcp ~keepalive t ~port cb registers the cb callback on the TCPv6 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 TCP.listen instead (since mirage-protocols 6.0.0).
Sourceval 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.

Sourceval connect : Udpv6_socket.t -> Tcpv6_socket.t -> t Lwt.t
OCaml

Innovation. Community. Security.