package tcpip

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (7)

Authors

  1. A
    Anil Madhavapeddy
  2. B
    Balraj Singh
  3. R
    Richard Mortier
  4. N
    Nicolas Ojeda Bar
  5. T
    Thomas Gazagnaire
  6. V
    Vincent Bernardoff
  7. M
    Magnus Skjegstad
  8. M
    Mindy Preston
  9. T
    Thomas Leonard
  10. D
    David Scott
  11. G
    Gabor Pali
  12. H
    Hannes Mehnert
  13. H
    Haris Rotsos
  14. K
    Kia
  15. L
    Luke Dunstan
  16. P
    Pablo Polvorin
  17. T
    Tim Cuthbertson
  18. L
    lnmx
  19. P
    pqwy

Maintainers

  1. A
    anil@recoil.org

Sources

tcpip-7.1.2.tbz
sha256=96b6aeafa35f143f7275d1becb6d639472adf3680b8180416de765b6581c466d
sha512=3f873c986de5c58df72db2953c6b2a6319963dbbbd0781b55c2878fd1eaa081ebb7cecbee595db7cb3680a6f438904f98cb69ca17e70c7a6d2d1f61277e929bd

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

Module Tcpip_stack_direct.MakeV4V6Source

Parameters

module Arpv4 : Arp.S
module Ip : Tcpip.Ip.S with type ipaddr = Ipaddr.t
module Icmpv4 : Icmpv4.S
module Udp : Tcpip.Udp.S with type ipaddr = Ipaddr.t
module Tcp : Tcpip.Tcp.S with type ipaddr = Ipaddr.t

Signature

include Tcpip.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).
Sourceval 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 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.

Sourceval connect : Netif.t -> Ethernet.t -> Arpv4.t -> Ip.t -> Icmpv4.t -> Udp.t -> Tcp.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.