Skip to content
This repository has been archived by the owner on Jun 30, 2019. It is now read-only.

Commit

Permalink
Update udns doc to c64ad9c.
Browse files Browse the repository at this point in the history
  • Loading branch information
hannesm committed Apr 3, 2019
1 parent 9d52038 commit ea1a121
Show file tree
Hide file tree
Showing 13 changed files with 14 additions and 11 deletions.
3 changes: 2 additions & 1 deletion doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="udns/index.html">udns</a> <span class="version">e9312af</span></li>
<li><a href="udns/index.html">udns</a> <span class="version">c64ad9c</span></li>
<li><a href="udns-certify/index.html">udns-certify</a></li>
<li><a href="udns-cli/index.html">udns-cli</a></li>
<li><a href="udns-client/index.html">udns-client</a></li>
<li><a href="udns-client-lwt/index.html">udns-client-lwt</a></li>
Expand Down
Empty file.
2 changes: 2 additions & 0 deletions doc/udns-certify/Udns_certify/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Udns_certify (udns-certify.Udns_certify)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../index.html">udns-certify</a> &#x00BB; Udns_certify</nav><h1>Module <code>Udns_certify</code></h1></header><dl><dt class="spec value" id="val-nsupdate"><a href="#val-nsupdate" class="anchor"></a><code><span class="keyword">val</span> nsupdate : (int <span>&#45;&gt;</span> Cstruct.t) <span>&#45;&gt;</span> (unit <span>&#45;&gt;</span> Ptime.t) <span>&#45;&gt;</span> host:Domain_name.t <span>&#45;&gt;</span> keyname:Domain_name.t <span>&#45;&gt;</span> zone:Domain_name.t <span>&#45;&gt;</span> <a href="../../udns/Udns/Dnskey/index.html#type-t">Udns.Dnskey.t</a> <span>&#45;&gt;</span> X509.CA.signing_request <span>&#45;&gt;</span> (Cstruct.t * (Cstruct.t <span>&#45;&gt;</span> (unit, string) Stdlib.result), string) Stdlib.result</code></dt><dt class="spec value" id="val-query"><a href="#val-query" class="anchor"></a><code><span class="keyword">val</span> query : (int <span>&#45;&gt;</span> Cstruct.t) <span>&#45;&gt;</span> X509.public_key <span>&#45;&gt;</span> Domain_name.t <span>&#45;&gt;</span> Cstruct.t * (Cstruct.t <span>&#45;&gt;</span> (X509.t, string) Stdlib.result)</code></dt></dl></div></body></html>
2 changes: 2 additions & 0 deletions doc/udns-certify/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (udns-certify.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – udns-certify</nav></header><h1 id="udns-certify-index"><a href="#udns-certify-index" class="anchor"></a>udns-certify index</h1><h2 id="library-udns-certify"><a href="#library-udns-certify" class="anchor"></a>Library udns-certify</h2><p>The entry point of this library is the module: <a href="Udns_certify/index.html"><code>Udns_certify</code></a>.</p></div></body></html>
2 changes: 1 addition & 1 deletion doc/udns-server/Udns_server/Primary/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Primary (udns-server.Udns_server.Primary)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">udns-server</a> &#x00BB; <a href="../index.html">Udns_server</a> &#x00BB; Primary</nav><h1>Module <code>Udns_server.Primary</code></h1></header><dl><dt class="spec type" id="type-s"><a href="#type-s" class="anchor"></a><code><span class="keyword">type</span> s</code></dt><dd><p>The state of a primary DNS server.</p></dd></dl><dl><dt class="spec value" id="val-server"><a href="#val-server" class="anchor"></a><code><span class="keyword">val</span> server : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> <a href="../index.html#type-t">t</a></code></dt><dd><p><code>server s</code> is the server of the primary.</p></dd></dl><dl><dt class="spec value" id="val-data"><a href="#val-data" class="anchor"></a><code><span class="keyword">val</span> data : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> <a href="../../Udns_trie/index.html#type-t">Udns_trie.t</a></code></dt><dd><p><code>data s</code> is the data store of <code>s</code>.</p></dd></dl><dl><dt class="spec value" id="val-with_data"><a href="#val-with_data" class="anchor"></a><code><span class="keyword">val</span> with_data : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> <a href="../../Udns_trie/index.html#type-t">Udns_trie.t</a> <span>&#45;&gt;</span> <a href="index.html#type-s">s</a></code></dt><dd><p><code>with_data s trie</code> replaces the current data with <code>trie</code> in <code>s</code>.</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : ?&#8288;keys:(Domain_name.t * <a href="../../../udns/Udns/Dnskey/index.html#type-t">Udns.Dnskey.t</a>) list <span>&#45;&gt;</span> ?&#8288;a:<a href="../Authentication/index.html#type-a">Authentication.a</a> list <span>&#45;&gt;</span> tsig_verify:<a href="../../../udns/Udns/Tsig_op/index.html#type-verify">Udns.Tsig_op.verify</a> <span>&#45;&gt;</span> tsig_sign:<a href="../../../udns/Udns/Tsig_op/index.html#type-sign">Udns.Tsig_op.sign</a> <span>&#45;&gt;</span> rng:(int <span>&#45;&gt;</span> Cstruct.t) <span>&#45;&gt;</span> <a href="../../Udns_trie/index.html#type-t">Udns_trie.t</a> <span>&#45;&gt;</span> <a href="index.html#type-s">s</a></code></dt><dd><p><code>create ~keys ~a ~tsig_verify ~tsig_sign ~rng data</code> creates a primary server.</p></dd></dl><dl><dt class="spec value" id="val-handle_frame"><a href="#val-handle_frame" class="anchor"></a><code><span class="keyword">val</span> handle_frame : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> Ipaddr.V4.t <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <a href="../../../udns/Udns/index.html#type-proto">Udns.proto</a> <span>&#45;&gt;</span> Domain_name.t option <span>&#45;&gt;</span> <a href="../../../udns/Udns/Packet/Header/index.html#type-t">Udns.Packet.Header.t</a> <span>&#45;&gt;</span> <a href="../../../udns/Udns/Packet/Question/index.html#type-t">Udns.Packet.Question.t</a> <span>&#45;&gt;</span> <a href="../../../udns/Udns/Packet/index.html#type-t">Udns.Packet.t</a> <span>&#45;&gt;</span> <a href="../../../udns/Udns/Name_rr_map/index.html#type-t">Udns.Name_rr_map.t</a> <span>&#45;&gt;</span> (<a href="index.html#type-s">s</a> * (<a href="../../../udns/Udns/Packet/Header/index.html#type-t">Udns.Packet.Header.t</a> * <a href="../../../udns/Udns/Packet/index.html#type-t">Udns.Packet.t</a> * <a href="../../../udns/Udns/Name_rr_map/index.html#type-t">Udns.Name_rr_map.t</a> option) option * (Ipaddr.V4.t * int * Cstruct.t) list * [ `Notify | `Signed_notify ] option, <a href="../../../udns/Udns_enum/index.html#type-rcode">Udns_enum.rcode</a>) Stdlib.result</code></dt><dd><p><code>handle_frame s now src src_port proto key hdr v</code> handles the given <code>frame</code>, returning new state, an answer, and potentially notify packets to secondary name servers.</p></dd></dl><dl><dt class="spec value" id="val-handle"><a href="#val-handle" class="anchor"></a><code><span class="keyword">val</span> handle : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> Ptime.t <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="../../../udns/Udns/index.html#type-proto">Udns.proto</a> <span>&#45;&gt;</span> Ipaddr.V4.t <span>&#45;&gt;</span> int <span>&#45;&gt;</span> Cstruct.t <span>&#45;&gt;</span> <a href="index.html#type-s">s</a> * Cstruct.t option * (Ipaddr.V4.t * int * Cstruct.t) list * [ `Notify | `Signed_notify ] option</code></dt><dd><p><code>handle s now ts proto src src_port buffer</code> decodes the <code>buffer</code>, processes the DNS frame using <a href="index.html#val-handle_frame"><code>handle_frame</code></a>, and encodes the reply.</p></dd></dl><dl><dt class="spec value" id="val-closed"><a href="#val-closed" class="anchor"></a><code><span class="keyword">val</span> closed : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> Ipaddr.V4.t <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <a href="index.html#type-s">s</a></code></dt><dd><p><code>closed s ip port</code> marks the connection to <code>ip, port</code> closed.</p></dd></dl><dl><dt class="spec value" id="val-timer"><a href="#val-timer" class="anchor"></a><code><span class="keyword">val</span> timer : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="index.html#type-s">s</a> * (Ipaddr.V4.t * int * Cstruct.t) list</code></dt><dd><p><code>timer s now</code> may encode some notify if they were not acknowledget by the other side.</p></dd></dl></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Primary (udns-server.Udns_server.Primary)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">udns-server</a> &#x00BB; <a href="../index.html">Udns_server</a> &#x00BB; Primary</nav><h1>Module <code>Udns_server.Primary</code></h1></header><dl><dt class="spec type" id="type-s"><a href="#type-s" class="anchor"></a><code><span class="keyword">type</span> s</code></dt><dd><p>The state of a primary DNS server.</p></dd></dl><dl><dt class="spec value" id="val-server"><a href="#val-server" class="anchor"></a><code><span class="keyword">val</span> server : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> <a href="../index.html#type-t">t</a></code></dt><dd><p><code>server s</code> is the server of the primary.</p></dd></dl><dl><dt class="spec value" id="val-data"><a href="#val-data" class="anchor"></a><code><span class="keyword">val</span> data : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> <a href="../../Udns_trie/index.html#type-t">Udns_trie.t</a></code></dt><dd><p><code>data s</code> is the data store of <code>s</code>.</p></dd></dl><dl><dt class="spec value" id="val-with_data"><a href="#val-with_data" class="anchor"></a><code><span class="keyword">val</span> with_data : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> <a href="../../Udns_trie/index.html#type-t">Udns_trie.t</a> <span>&#45;&gt;</span> <a href="index.html#type-s">s</a></code></dt><dd><p><code>with_data s trie</code> replaces the current data with <code>trie</code> in <code>s</code>.</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : ?&#8288;keys:(Domain_name.t * <a href="../../../udns/Udns/Dnskey/index.html#type-t">Udns.Dnskey.t</a>) list <span>&#45;&gt;</span> ?&#8288;a:<a href="../Authentication/index.html#type-a">Authentication.a</a> list <span>&#45;&gt;</span> tsig_verify:<a href="../../../udns/Udns/Tsig_op/index.html#type-verify">Udns.Tsig_op.verify</a> <span>&#45;&gt;</span> tsig_sign:<a href="../../../udns/Udns/Tsig_op/index.html#type-sign">Udns.Tsig_op.sign</a> <span>&#45;&gt;</span> rng:(int <span>&#45;&gt;</span> Cstruct.t) <span>&#45;&gt;</span> <a href="../../Udns_trie/index.html#type-t">Udns_trie.t</a> <span>&#45;&gt;</span> <a href="index.html#type-s">s</a></code></dt><dd><p><code>create ~keys ~a ~tsig_verify ~tsig_sign ~rng data</code> creates a primary server.</p></dd></dl><dl><dt class="spec value" id="val-handle_frame"><a href="#val-handle_frame" class="anchor"></a><code><span class="keyword">val</span> handle_frame : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="../../../udns/Udns/index.html#type-proto">Udns.proto</a> <span>&#45;&gt;</span> Ipaddr.V4.t <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <a href="../../../udns/Udns/Packet/Header/index.html#type-t">Udns.Packet.Header.t</a> <span>&#45;&gt;</span> <a href="../../../udns/Udns/Packet/Question/index.html#type-t">Udns.Packet.Question.t</a> <span>&#45;&gt;</span> <a href="../../../udns/Udns/Packet/index.html#type-t">Udns.Packet.t</a> <span>&#45;&gt;</span> <a href="../../../udns/Udns/Name_rr_map/index.html#type-t">Udns.Name_rr_map.t</a> <span>&#45;&gt;</span> Domain_name.t option <span>&#45;&gt;</span> (<a href="index.html#type-s">s</a> * (<a href="../../../udns/Udns/Packet/Header/index.html#type-t">Udns.Packet.Header.t</a> * <a href="../../../udns/Udns/Packet/index.html#type-t">Udns.Packet.t</a> * <a href="../../../udns/Udns/Name_rr_map/index.html#type-t">Udns.Name_rr_map.t</a> option) option * (Ipaddr.V4.t * int * Cstruct.t) list * [ `Notify | `Signed_notify ] option, <a href="../../../udns/Udns_enum/index.html#type-rcode">Udns_enum.rcode</a>) Stdlib.result</code></dt><dd><p><code>handle_frame s now src src_port proto key hdr v</code> handles the given <code>frame</code>, returning new state, an answer, and potentially notify packets to secondary name servers.</p></dd></dl><dl><dt class="spec value" id="val-handle"><a href="#val-handle" class="anchor"></a><code><span class="keyword">val</span> handle : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> Ptime.t <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="../../../udns/Udns/index.html#type-proto">Udns.proto</a> <span>&#45;&gt;</span> Ipaddr.V4.t <span>&#45;&gt;</span> int <span>&#45;&gt;</span> Cstruct.t <span>&#45;&gt;</span> <a href="index.html#type-s">s</a> * Cstruct.t option * (Ipaddr.V4.t * int * Cstruct.t) list * [ `Notify | `Signed_notify ] option</code></dt><dd><p><code>handle s now ts proto src src_port buffer</code> decodes the <code>buffer</code>, processes the DNS frame using <a href="index.html#val-handle_frame"><code>handle_frame</code></a>, and encodes the reply.</p></dd></dl><dl><dt class="spec value" id="val-closed"><a href="#val-closed" class="anchor"></a><code><span class="keyword">val</span> closed : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> Ipaddr.V4.t <span>&#45;&gt;</span> int <span>&#45;&gt;</span> <a href="index.html#type-s">s</a></code></dt><dd><p><code>closed s ip port</code> marks the connection to <code>ip, port</code> closed.</p></dd></dl><dl><dt class="spec value" id="val-timer"><a href="#val-timer" class="anchor"></a><code><span class="keyword">val</span> timer : <a href="index.html#type-s">s</a> <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="index.html#type-s">s</a> * (Ipaddr.V4.t * int * Cstruct.t) list</code></dt><dd><p><code>timer s now</code> may encode some notify if they were not acknowledget by the other side.</p></dd></dl></div></body></html>
Loading

0 comments on commit ea1a121

Please sign in to comment.