package tcpip

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

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License 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-v6.4.0.tbz
sha256=6e32bf540d291e9b7325cb3dd00df2f695533e009c46ea534d5518b9492c7348
sha512=2e9f9ca2eeac637599eb48e087b4632598539f1c76f9251758995c7eedeb723f8b951d557a2a53b85a58d50a04e68e15598581f88fca8997733e800fcfca422b

doc/tcpip.stack-direct/Tcpip_stack_direct/MakeV4V6/argument-3-Netif/index.html

Parameter MakeV4V6.Netif

type error = private [>
  1. | Mirage_net.Net.error
]

The type for network interface errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

type t

The type representing the internal state of the network device.

val disconnect : t -> unit Lwt.t

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

val write : t -> size:int -> (Cstruct.t -> int) -> (unit, error) result Lwt.t

write net ~size fill allocates a buffer of length size, where size must not exceed the interface maximum packet size (mtu plus Ethernet header). The allocated buffer is zeroed and passed to the fill function which returns the payload length, which may not exceed the length of the buffer. When fill returns, a sub buffer is put on the wire: the allocated buffer from index 0 to the returned length.

val listen : t -> header_size:int -> (Cstruct.t -> unit Lwt.t) -> (unit, error) result Lwt.t

listen ~header_size net fn waits for a packet with size at most header_size + mtu on the network device. When a packet is received, an asynchronous task is created in which fn packet is called. The ownership of packet is transferred to fn. The function can be stopped by calling disconnect.

val mac : t -> Macaddr.t

mac net is the MAC address of net.

val mtu : t -> int

mtu net is the Maximum Transmission Unit of net. This excludes the Ethernet header.

val get_stats_counters : t -> Mirage_net.stats

Obtain the most recent snapshot of the interface statistics.

val reset_stats_counters : t -> unit

Reset the statistics associated with this interface to their defaults.