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/Make/index.html

Module Tcpip_stack_direct.MakeSource

Parameters

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

Signature

include Tcpip.Stack.V4 with module IPV4 = Ipv4 and module TCPV4 = Tcpv4 and module UDPV4 = Udpv4
Sourcetype t

The type representing the internal state of the IPv4 stack.

Sourceval disconnect : t -> unit Lwt.t

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

module UDPV4 = Udpv4
module TCPV4 = Tcpv4
module IPV4 = Ipv4
Sourceval udpv4 : t -> UDPV4.t

udpv4 t obtains a descriptor for use with the UDPV4 module, usually to transmit traffic.

Sourceval tcpv4 : t -> TCPV4.t

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

Sourceval ipv4 : t -> IPV4.t

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

Sourceval listen_udpv4 : t -> port:int -> UDPV4.callback -> unit

listen_udpv4 t ~port cb registers the cb callback on the UDPv4 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 UDPV4.listen instead (since mirage-protocols 6.0.0).
Sourceval listen_tcpv4 : ?keepalive:Tcpip.Tcp.Keepalive.t -> t -> port:int -> (TCPV4.flow -> unit Lwt.t) -> unit

listen_tcpv4 ~keepalive t ~port cb registers the cb callback on the TCPv4 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 TCPV4.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 -> Ipv4.t -> Icmpv4.t -> Udpv4.t -> Tcpv4.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 (e.g. ARP) are functioning, so that if the user wishes to establish outbound connections, they will be able to do so.