package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

OCaml TCP/IP networking stack, used in MirageOS

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (7)

Authors

Maintainers

A

anil@recoil.org

Sources

tcpip-7.1.2.tbz

sha256=96b6aeafa35f143f7275d1becb6d639472adf3680b8180416de765b6581c466d

sha512=3f873c986de5c58df72db2953c6b2a6319963dbbbd0781b55c2878fd1eaa081ebb7cecbee595db7cb3680a6f438904f98cb69ca17e70c7a6d2d1f61277e929bd

doc/tcpip.stack-direct/Tcpip_stack_direct/MakeV6/index.html

Module `Tcpip_stack_direct.MakeV6`Source

Parameters

module Time : Mirage_time.S

module Random : Mirage_random.S

module Netif : Mirage_net.S

module Ethernet : Ethernet.S

module Ipv6 : Tcpip.Ip.S with type ipaddr = Ipaddr.V6.t

module Udpv6 : Tcpip.Udp.S with type ipaddr = Ipaddr.V6.t

module Tcpv6 : Tcpip.Tcp.S with type ipaddr = Ipaddr.V6.t

Signature

include Tcpip.Stack.V6
  with module IP = Ipv6
   and module TCP = Tcpv6
   and module UDP = Udpv6

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.

module UDP = Udpv6

module TCP = Tcpv6

module IP = Ipv6

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).

Source

val listen_tcp : 
  ?keepalive:Tcpip.Tcp.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 : Netif.t -> Ethernet.t -> Ipv6.t -> Udpv6.t -> Tcpv6.t -> t Lwt.t

connect assembles the arguments into a network stack, then calls `listen` on the assembled stack before returning it to the caller. The initial `listen` functions to ensure that the lower-level layers are functioning, so that if the user wishes to establish outbound connections, they will be able to do so.

On This Page

Parameters
Signature