package tcpip

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

OCaml TCP/IP networking stack, used in MirageOS

Install

dune-project

Dependency

github.com Edit opam file Versions (7)

Authors

Maintainers

A

anil@recoil.org

Sources

tcpip-v6.4.0.tbz

sha256=6e32bf540d291e9b7325cb3dd00df2f695533e009c46ea534d5518b9492c7348

sha512=2e9f9ca2eeac637599eb48e087b4632598539f1c76f9251758995c7eedeb723f8b951d557a2a53b85a58d50a04e68e15598581f88fca8997733e800fcfca422b

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

Module `Tcpip_stack_direct.MakeV4V6`Source

Parameters

module Time : Mirage_time.S

module Random : Mirage_random.S

module Netif : Mirage_net.S

module Ethernet : Mirage_protocols.ETHERNET

module Arpv4 : Mirage_protocols.ARP

module Ip : Mirage_protocols.IP with type ipaddr = Ipaddr.t

module Icmpv4 : Mirage_protocols.ICMP with type ipaddr = Ipaddr.V4.t

module Udp : UDPV4V6_DIRECT

module Tcp : TCPV4V6_DIRECT

Signature

include Mirage_stack.V4V6
  with module IP = Ip
   and module TCP = Tcp
   and module UDP = Udp

Sourcetype t

The type representing the internal state of the dual IPv4 and IPv6 stack.

Sourceval disconnect : t -> unit Lwt.t

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

module UDP = Udp

module TCP = Tcp

module IP = Ip

Sourceval udp : t -> UDP.t

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

Sourceval tcp : t -> TCP.t

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

Sourceval ip : t -> IP.t

ip t obtains a descriptor for use with the IP module, which can handle raw IPv4 and 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 UDP 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: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 TCP 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.