package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Tcpip_checksum
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip.icmpv4-socket
- Icmpv4_socket
tcpip.ipv4
- Fragments
  - Cache
  - K
  - V
- Ipv4_common
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    A
- Static_ipv4
  - Make
    
    A
    
    C
    
    E
tcpip.ipv6
- Ipv6
  - Make
    
    Clock
    
    E
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - Make
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ipv4
    
    Tcpv4
    
    Udpv4
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Tcp
    
    Udp
  - MakeV6
    
    Ethernet
    
    Ipv6
    
    Tcpv6
    
    Udpv6
  - TCPV4V6_DIRECT
  - TCPV4_DIRECT
  - TCPV6_DIRECT
  - UDPV4V6_DIRECT
  - UDPV4_DIRECT
  - UDPV6_DIRECT
tcpip.stack-socket
- Ipv4_socket
- Ipv4v6_socket
- Ipv6_socket
- Tcpip_stack_socket
  - V4
  - V4V6
  - V6
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    Immediate
    
    M
  - Flow
    
    Make
    
    C
    
    IP
  - Keepalive
    
    Make
    
    Clock
  - Options
  - Segment
    
    Rx
    
    Tx
    
    Clock
  - Sequence
  - State
    
    Make
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
  - User_buffer
    
    Rx
    
    Tx
    
    Clock
    
    TXS
  - Window
    
    Make
    
    C
  - Wire
    
    Make
    
    Ip
tcpip.tcp_socket_options
- Tcp_socket_options
tcpip.tcpv4-socket
- Tcp_socket
- Tcpv4_socket
tcpip.tcpv4v6-socket
- Tcpv4v6_socket
tcpip.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
    
    IP
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv4v6-socket
- Udpv4v6_socket
tcpip.udpv6-socket
- Udpv6_socket
tcpip.unix
- Tcpip_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

The type representing the internal state of the ARP layer.

val disconnect : t -> unit Lwt.t

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

type error = private [>

| Mirage_protocols.Arp.error

]

The type for ARP errors.

val pp_error : error Fmt.t

pp_error is the pretty-printer for errors.

val pp : t Fmt.t

Prettyprint cache contents

val get_ips : t -> Ipaddr.V4.t list

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

val set_ips : t -> Ipaddr.V4.t list -> unit Lwt.t

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

val remove_ip : t -> Ipaddr.V4.t -> unit Lwt.t

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.V4.t -> unit Lwt.t

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.V4.t -> (Macaddr.t, error) Stdlib.result Lwt.t

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 -> Cstruct.t -> unit Lwt.t

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.