package mirage-nat

You can search for identifiers within the package.

in-package search v0.2.0

package mirage-nat

mirage-nat
- Mirage_nat
  - S
  - SUBTABLE
  - TABLE
    
    ICMP
    
    TCP
    
    UDP
- Mirage_nat_lru
- Nat_packet
- Nat_rewrite
  - Make
    
    Table
    
    ICMP
    
    TCP
    
    UDP

Legend:
Library
Module
Module type
Parameter
Class
Class type

An ICMP query is identified by the ICMP ID.

type transport_channel = Cstruct.uint16

type channel = Ipaddr.V4.t * Ipaddr.V4.t * transport_channel

val lookup : t -> channel -> (Mirage_nat.time * channel) option Lwt.t

lookup t channel is Some (expiry, translated_channel) - the new endpoints that should be applied to a packet using channel - or None if no entry for channel exists. expiry is an absolute time-stamp.

val insert : 
  t ->
  expiry:Mirage_nat.time ->
  (channel * channel) list ->
  (unit, [> `Overlap ]) result Lwt.t

insert t ~expiry translations adds the given translations to the table. Each translation is a pair input, target - packets with channel input should be rewritten to have channel output. It returns an error if the new entries would overlap with existing entries. expiry is the absolute time-stamp of the desired expiry time.

val delete : t -> channel list -> unit Lwt.t

delete t sources removes the entries mapping sources, if they exist.