package tcpip

You can search for identifiers within the package.

in-package search v0.2.0

package tcpip

tcpip
- Tcpip
  - Ip
    
    S
  - Stack
    
    V4V6
    
    IP
    
    TCP
    
    UDP
  - Tcp
    
    Keepalive
    
    S
  - Udp
    
    S
tcpip.checksum
- Tcpip_checksum
tcpip.icmpv4
- Icmpv4
  - Make
    
    I
  - S
- Icmpv4_packet
  - Marshal
  - Unmarshal
- Icmpv4_wire
tcpip.icmpv4-socket
- Icmpv4_socket
tcpip.ipv4
- Fragments
  - Cache
  - K
  - V
- Ipv4_packet
  - Marshal
  - Unmarshal
- Ipv4_wire
- Routing
  - Make
    
    A
    
    Log
- Static_ipv4
  - Make
    
    A
    
    C
    
    E
    
    R
    
    Entropy
tcpip.ipv6
- Ipv6
  - Make
    
    Clock
    
    E
    
    N
    
    R
    
    Entropy
    
    T
- Ipv6_wire
  - Icmpv6
  - Llopt
  - Na
  - Ns
  - Opt
  - Opt_prefix
  - Pingv6
  - Ra
  - Redirect
  - Rs
- Ndpv6
tcpip.stack-direct
- Tcpip_stack_direct
  - IPV4V6
    
    Ipv4
    
    Ipv6
  - MakeV4V6
    
    Arpv4
    
    Ethernet
    
    Icmpv4
    
    Ip
    
    Netif
    
    Random
    
    Entropy
    
    Tcp
    
    Time
    
    Udp
  - TCPV4V6
    
    S
    
    IP
    
    TCP
    
    UDP
tcpip.stack-socket
tcpip.tcp
- Tcp
  - Ack
    
    Delayed
    
    T
    
    Immediate
    
    M
  - Flow
    
    Make
    
    C
    
    IP
    
    R
    
    Entropy
    
    TM
  - Keepalive
    
    Make
    
    Clock
    
    T
  - Options
  - Segment
    
    Rx
    
    ACK
    
    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.tcpv4v6-socket
- Tcp_socket
- Tcpv4v6_socket
tcpip.udp
- Udp
  - Make
    
    IP
    
    R
    
    Entropy
- Udp_packet
  - Marshal
  - Unmarshal
- Udp_wire
tcpip.udpv4v6-socket
- Udpv4v6_socket
  - Log

Legend:
Library
Module
Module type
Parameter
Class
Class type

type ipaddr = Ipaddr.V6.t

type prefix = Ipaddr.V6.Prefix.t

type time = int64

val checksum : Cstruct.t -> Cstruct.t list -> int

type event = [

| `Tcp of ipaddr * ipaddr * Cstruct.t
| `Udp of ipaddr * ipaddr * Cstruct.t
| `Default of int * ipaddr * ipaddr * Cstruct.t

]

type context

val local : 
  handle_ra:bool ->
  now:time ->
  random:(int -> string) ->
  Macaddr.t ->
  context * (Macaddr.t * int * (Cstruct.t -> int)) list

local ~handle_ra ~now ~random mac is a pair ctx, outs where ctx is a local IPv6 context associated to the hardware address mac. outs is a list of ethif packets to be sent.

val add_ip : 
  now:time ->
  context ->
  prefix ->
  context * (Macaddr.t * int * (Cstruct.t -> int)) list

add_ip ~now ctx ip is ctx', outs where ctx' is ctx updated with a new local ip and outs is a list of ethif packets to be sent.

val get_ip : context -> ipaddr list

get_ip ctx returns the list of local ips.

val configured_ips : context -> prefix list

configured_ips ctx returns the list of local prefixes.

val select_source : context -> ipaddr -> ipaddr

select_source ctx ip returns the ip that should be put in the source field of a packet destined to ip.

val handle : 
  now:time ->
  random:(int -> string) ->
  context ->
  Cstruct.t ->
  context * (Macaddr.t * int * (Cstruct.t -> int)) list * event list

handle ~now ~random ctx buf handles an incoming ipv6 packet. It returns ctx', bufs, evs where ctx' is the updated context, bufs is a list of packets to be sent and evs is a list of packets to be passed to the higher layers (udp, tcp, etc) for further processing.

val send : 
  now:time ->
  context ->
  ?src:ipaddr ->
  ipaddr ->
  Tcpip.Ip.proto ->
  int ->
  (Cstruct.t -> Cstruct.t -> int) ->
  context * (Macaddr.t * int * (Cstruct.t -> int)) list

send ~now ctx ?src dst proto size fillf starts route resolution and assembles an ipv6 packet of size for sending with header and body passed to fillf. It returns a pair ctx', dst_size_fills where ctx' is the updated context and dst, size, fillf is a list of packets to be sent, specified by destination, their size, and fill function.

val tick : 
  now:time ->
  context ->
  context * (Macaddr.t * int * (Cstruct.t -> int)) list

tick ~now ctx should be called periodically (every 1s is good). It returns ctx', bufs where ctx' is the updated context and bufs is a list of packets to be sent.

val add_prefix : now:time -> context -> prefix -> context

add_prefix ~now ctx pfx adds a local prefix to ctx.

val get_prefix : context -> prefix list

get_prefix ctx returns the list of local prefixes known to ctx.

val add_routers : now:time -> context -> ipaddr list -> context

add_routers ~now ctx ips adds a list of gateways to ctx to be used for routing.

val get_routers : context -> ipaddr list

get_routers ctx returns the list of gateways known to ctx.