package tcpip
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=d452e23f4e62c8b32c977f742e72c50fe673b82e23dc80b29d8263be764d2c72
sha512=9a4aeb5c7ec0392524d1d261026e5de047dec09054f2dca63d9743aed1d27ccfd655ae693554091b4ef7d9eabfeef218e71e8bf13ea8304ebedd8e8a7d4f484a
doc/tcpip.ipv4/Static_ipv4/Make/index.html
Module Static_ipv4.Make
Source
Parameters
module R : Mirage_random.S
module C : Mirage_clock.MCLOCK
module E : Ethernet.S
Signature
include Tcpip.Ip.S with type ipaddr = Ipaddr.V4.t
The type for IP errors.
The type for IP addresses.
The type representing the internal state of the IP layer.
Disconnect from the IP layer. While this might take some time to complete, it can never result in an error.
An input continuation used by the parsing functions to pass on an input packet down the stack.
callback ~src ~dst buf
will be called with src
and dst
containing the source and destination IP address respectively, and buf
will be a buffer pointing at the start of the IP payload.
val input :
t ->
tcp:callback ->
udp:callback ->
default:(proto:int -> callback) ->
Cstruct.t ->
unit Lwt.t
input ~tcp ~udp ~default ip buf
demultiplexes an incoming buffer
that contains an IP frame. It examines the protocol header and passes the result onto either the tcp
or udp
function, or the default
function for unknown IP protocols.
val write :
t ->
?fragment:bool ->
?ttl:int ->
?src:ipaddr ->
ipaddr ->
Tcpip.Ip.proto ->
?size:int ->
(Cstruct.t -> int) ->
Cstruct.t list ->
(unit, error) result Lwt.t
write t ~fragment ~ttl ~src dst proto ~size headerf payload
allocates a buffer, writes the IP header, and calls the headerf function. This may write to the provided buffer of size
(default 0). If size + ip header
exceeds the maximum transfer unit, an error is returned. The payload
is appended. The optional fragment
argument defaults to true
, in which case multiple IP-fragmented frames are sent if the payload is too big for a single frame. When it is false
, the don't fragment bit is set and if the payload and header would exceed the maximum transfer unit, an error is returned.
pseudoheader t ~src dst proto len
gives a pseudoheader suitable for use in TCP or UDP checksum calculation based on t
.
src ip ~dst
is the source address to be used to send a packet to dst
. In the case of IPv4, this will always return the same IP, which is the only one set.
Get the IP addresses associated with this interface. For IPv4, only one IP address can be set at a time, so the list will always be of length 1 (and may be the default value, 0.0.0.0).
val connect :
?no_init:bool ->
cidr:Ipaddr.V4.Prefix.t ->
?gateway:Ipaddr.V4.t ->
?fragment_cache_size:int ->
E.t ->
A.t ->
t Lwt.t
connect ~no_init ~cidr ~gateway ~fragment_cache_size eth arp
connects the ipv4 device using cidr
and gateway
for network communication. The size of the IPv4 fragment cache (for reassembly) can be provided in byte-size of fragments (defaults to 256kB).