package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Tcpip_checksum
- Wire_structs
tcpip.arpv4
- Arpv4
  - Make
    
    Clock
    
    Ethif
    
    Time
- Arpv4_wire
tcpip.dhcpv4
- Dhcp_clientv4
  - Make
    
    Console
    
    Random
    
    Time
    
    Udp
- Dhcpv4_option
  - Marshal
  - Packet
  - Unmarshal
tcpip.ethif
- Ethif
  - Make
    
    N
tcpip.ipv4
- Ipv4
  - Make
    
    A
    
    N
    
    Routing
tcpip.ipv6
- Ipv6
  - Make
    
    C
    
    E
    
    T
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Console
    
    Ethif
    
    Ipv4
    
    Netif
    
    Random
    
    Tcpv4
    
    Time
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
tcpip.tcp
- Tcp
tcpip.tcpv4-socket
- Tcpv4_socket
tcpip.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
    
    IP
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv6-socket
- Udpv6_socket

Legend:
Library
Module
Module type
Parameter
Class
Class type

include V1.DEVICE with type 'a io = 'a Lwt.t

type 'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t

The type representing the internal state of the device

type error

The type for errors signalled by the device

type id

This type is no longer used and will be removed once other * modules stop using it in their type signatures.

val disconnect : t -> unit io

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

type ipaddr = Ipaddr.V4.t

type buffer = Cstruct.t

type macaddr = Macaddr.t

type repr

type result = [

| `Ok of macaddr
| `Timeout

]

Type of the result of an ARP query. One of `Ok macaddr (for successful queries) or `Timeout (for attempted queries that received no response).

val to_repr : t -> repr io

Prettyprint cache contents

val pp : Format.formatter -> repr -> unit

val get_ips : t -> ipaddr list

get_ips arp gets the bound IP address list in the arp value.

val set_ips : t -> ipaddr list -> unit io

set_ips arp sets the bound IP address list, which will transmit a GARP packet also.

val remove_ip : t -> ipaddr -> unit io

remove_ip arp ip removes ip to the bound IP address list in the arp value, which will transmit a GARP packet for any remaining IPs in the bound IP address list after the removal.

val add_ip : t -> ipaddr -> unit io

add_ip arp ip adds ip to the bound IP address list in the arp value, which will transmit a GARP packet also.

val query : t -> ipaddr -> result io

query arp ip queries the cache in arp for an ARP entry corresponding to ip, which may result in the sender sleeping waiting for a response.

val input : t -> buffer -> unit io

input arp frame will handle an ARP frame. If it is a response, it will update its cache, otherwise will try to satisfy the request.