package dns

  1. Overview
  2. Docs
An opinionated Domain Name System (DNS) library

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-2-Clause License Edit opam file Versions (14)

Authors

  1. H
    Hannes Mehnert <hannes@mehnert.org>
  2. R
    Reynir Björnsson <reynir@reynir.dk>

Maintainers

  1. T
    team AT robur dot coop

Sources

dns-10.2.2.tbz
sha256=5123d7167f5fb3a5ab70cf0b3ccc965089ec440dc07edeabf8c0568ee737a7f0
sha512=4e5945435f280591c158ab03fec19dc0c807fb713d6ee68873939899c49175f39af1fbcd135517514a3ab088993356a4c303f7dce5e18d403d4630a33bad9076

doc/dns.cache/Dns_cache/index.html

Module Dns_cacheSource

DNS cache - a least recently used cache of DNS responses

This data structure allows to insert and retrieve entries into a least recently used data structure. An `Entry weights the cardinality of the resource record map, all other entries have a weight of 1.

The time to live is preserved, and when it is exceeded the entry is no longer returned.

Sourcetype rank =
  1. | ZoneFile
  2. | ZoneTransfer
  3. | AuthoritativeAnswer of Dns.Rrsig.t option
  4. | AuthoritativeAuthority of Dns.Rrsig.t option
  5. | ZoneGlue
  6. | NonAuthoritativeAnswer
  7. | Additional

The variant of the rank in the cache.

Sourceval pp_rank : rank Fmt.t

pp_rank ppf rank pretty-prints the rank on ppf.

Sourceval compare_rank : rank -> rank -> int

compare_rank a b compares the ranks a with b.

Sourcetype t

The type of a DNS cache.

Sourceval empty : int -> t

empty maximum_size is an empty DNS cache with the maximum size as capacity.

Sourceval size : t -> int

size cache is the number of bindings currently in the cache.

Sourceval capacity : t -> int

capacity cache is the used weight.

Sourceval pp : t Fmt.t

pp ppf t pretty prints the cache t on ppf.

Sourcetype 'a entry = [
  1. | `Entry of 'a
  2. | `No_data of [ `raw ] Domain_name.t * Dns.Soa.t
  3. | `No_domain of [ `raw ] Domain_name.t * Dns.Soa.t
  4. | `Serv_fail of [ `raw ] Domain_name.t * Dns.Soa.t
]

The polymorphic variant of an entry: a resource record, or no data, no domain, or a server failure.

Sourceval pp_entry : 'a Dns.Rr_map.key -> 'a entry Fmt.t

pp_entry ppf entry pretty-prints entry on ppf.

Sourceval get : t -> int64 -> [ `raw ] Domain_name.t -> 'a Dns.Rr_map.key -> t * ('a entry * rank, [ `Cache_miss | `Cache_drop ]) result

get cache timestamp type name retrieves the query type, name from the cache using timestamp. If the time to live is exceeded, a `Cache_drop is returned. If there is no entry in the cache, a `Cache_miss is returned.

Sourceval get_or_cname : t -> int64 -> [ `raw ] Domain_name.t -> 'a Dns.Rr_map.key -> t * ([ 'a entry | `Alias of int32 * [ `raw ] Domain_name.t ] * rank, [ `Cache_miss | `Cache_drop ]) result

get_or_cname cache timestamp type name is the same as get, but if a `Cache_miss is encountered, a lookup for an alias (CNAME) is done.

Sourceval get_any : t -> int64 -> [ `raw ] Domain_name.t -> t * ([ `Entries of Dns.Rr_map.t | `No_domain of [ `raw ] Domain_name.t * Dns.Soa.t ] * rank, [ `Cache_miss | `Cache_drop ]) result

get_any cache timestamp name retrieves all resource records for name in cache.

Sourceval get_nsec3 : t -> int64 -> [ `raw ] Domain_name.t -> t * (([ `raw ] Domain_name.t * int32 * Dns.Nsec3.t * rank) list, [ `Cache_miss | `Cache_drop ]) result

get_nsec3 cache timestamp name retrieves all nsec3 resource records for the zone name.

Sourceval set : t -> int64 -> [ `raw ] Domain_name.t -> 'a Dns.Rr_map.key -> rank -> 'a entry -> t

set cache timestamp type name rank value attempts to insert type, name, value into the cache using the timestamp and rank. If an entry already exists with a higher rank, the cache is unchanged.

Sourceval remove : t -> [ `raw ] Domain_name.t -> t

remove cache name removes name from cache.