package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package tcpip

tcpip
- Tcpip_checksum
tcpip.arpv4
- Arpv4
  - Make
    
    Clock
    
    Ethif
    
    Time
- Arpv4_packet
  - Marshal
  - Unmarshal
- Arpv4_wire
tcpip.ethif
- Ethif
  - Make
    
    N
- Ethif_packet
  - Marshal
  - Unmarshal
- Ethif_wire
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip.icmpv4-socket
- Icmpv4_socket
tcpip.ipv4
- Ipv4_common
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    A
    
    Log
- Static_ipv4
  - Make
    
    A
    
    C
    
    E
    
    R
tcpip.ipv6
- Ipv6
  - Make
    
    Clock
    
    E
    
    R
    
    T
- Ipv6_wire
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - Make
    
    Arpv4
    
    Ethif
    
    Icmpv4
    
    Ipv4
    
    Netif
    
    Random
    
    Tcpv4
    
    Time
    
    Udpv4
  - TCPV4_DIRECT
  - UDPV4_DIRECT
tcpip.stack-socket
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    T
    
    Immediate
    
    M
  - Flow
    
    Make
    
    C
    
    IP
    
    R
    
    TM
  - Keepalive
    
    Make
    
    Clock
    
    T
  - Options
  - Segment
    
    Rx
    
    T
    
    Tx
    
    Clock
    
    Time
  - Sequence
  - State
    
    Make
    
    Time
  - Stats
    
    Gc
  - Tcp_packet
    
    Marshal
    
    Unmarshal
  - Tcp_wire
  - Tcptimer
    
    Make
    
    T
  - User_buffer
    
    Rx
    
    Tx
    
    Clock
    
    TXS
    
    Time
  - Window
    
    Make
    
    C
  - Wire
    
    Make
    
    Ip
tcpip.tcp_socket_options
- Tcp_socket_options
tcpip.tcpv4-socket
- Tcp_socket
- Tcpv4_socket
tcpip.tcpv6-socket
- Tcpv6_socket
tcpip.udp
- Udp
  - Make
    
    IP
    
    R
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4-socket
- Udpv4_socket
tcpip.udpv6-socket
- Udpv6_socket
tcpip.unix
- Tcpip_unix
tcpip.xen
- Tcpip_xen

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Ethif : Mirage_protocols_lwt.ETHIF

module Clock : Mirage_clock.MCLOCK

module Time : Mirage_time_lwt.S

Signature

include Mirage_protocols_lwt.ARP

include Mirage_device.S 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

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 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 to_repr : t -> repr io

Prettyprint cache contents

val pp : repr Fmt.t

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 -> (macaddr, error) Pervasives.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.

val connect : Ethif.t -> Clock.t -> t Lwt.t

connect creates a value of type t.