diff options
author | Laurent Bercot <ska-skaware@skarnet.org> | 2017-03-11 16:44:23 +0000 |
---|---|---|
committer | Laurent Bercot <ska-skaware@skarnet.org> | 2017-03-11 16:44:23 +0000 |
commit | 22cf41f697ff6de1eb4d6c5f66e5de70e86c9f74 (patch) | |
tree | ca8e781d5f8ee611c4adaaaf0b7892120e21e298 /doc/libs6dns | |
parent | 5ad27a3dc4b957191e2e657d41656810138ba789 (diff) | |
download | s6-dns-22cf41f697ff6de1eb4d6c5f66e5de70e86c9f74.tar.xz |
Update documentation, fix wrong types
Diffstat (limited to 'doc/libs6dns')
-rw-r--r-- | doc/libs6dns/s6dns-domain.html | 8 | ||||
-rw-r--r-- | doc/libs6dns/s6dns-engine.html | 2 | ||||
-rw-r--r-- | doc/libs6dns/s6dns-fmt.html | 12 | ||||
-rw-r--r-- | doc/libs6dns/s6dns-resolve.html | 30 |
4 files changed, 26 insertions, 26 deletions
diff --git a/doc/libs6dns/s6dns-domain.html b/doc/libs6dns/s6dns-domain.html index 88b9621..8badbb0 100644 --- a/doc/libs6dns/s6dns-domain.html +++ b/doc/libs6dns/s6dns-domain.html @@ -49,7 +49,7 @@ on the stack. <h2> Functions </h2> <p> -<code> int s6dns_domain_fromstring (s6dns_domain_t *d, char const *s, unsigned int len) </code> <br /> +<code> int s6dns_domain_fromstring (s6dns_domain_t *d, char const *s, size_t len) </code> <br /> Makes a (string form) domain from string <em>s</em> of length <em>len</em>, and stores it into *<em>d</em>. Returns 1 if it succeeds, otherwise it returns 0 and sets errno appropriately - most likely ENAMETOOLONG, i.e. @@ -104,20 +104,20 @@ valid packet form (EPROTO). </p> <p> -<code> int s6dns_domain_fromstring_noqualify_encode (s6dns_domain_t *d, char const *s, unsigned int len) </code> <br /> +<code> int s6dns_domain_fromstring_noqualify_encode (s6dns_domain_t *d, char const *s, size_t len) </code> <br /> Higher-level function wrapping some of the above. Makes an encoded, fully qualified (without resorting to qualification) domain from string <em>s</em> of length <em>len</em>. Returns 1 if it succeeds and 0 if it fails. </p> <p> -<code> unsigned int s6dns_domain_fromstring_qualify_encode (s6dns_domain_t *list, char const *s, unsigned int len, char const *rules, unsigned int rulesnum) </code> <br /> +<code> unsigned int s6dns_domain_fromstring_qualify_encode (s6dns_domain_t *list, char const *s, size_t len, char const *rules, unsigned int rulesnum) </code> <br /> Another wrapping function. It makes a list of encoded, fully qualified domains, from string <em>s</em> of length <em>len</em> using <em>rulesnum</em> qualification rules in <em>rules</em>. It writes at most <em>rulesnum</em> domains into the array pointed to by <em>list</em> and returns the number of written domains, or 0 on an error. -</p> + </p> <p> <code> void s6dns_domain_arpafromip4 (s6dns_domain_t *d, char const *ip) </code> <br /> diff --git a/doc/libs6dns/s6dns-engine.html b/doc/libs6dns/s6dns-engine.html index 61b966e..24105c9 100644 --- a/doc/libs6dns/s6dns-engine.html +++ b/doc/libs6dns/s6dns-engine.html @@ -79,7 +79,7 @@ after each use. It contains a stralloc, so it must be freed with <h3> <tt>s6dns_engine_t</tt> life cycle </h3> <p> -<code> int s6dns_engine_init (s6dns_engine_t *dt, s6dns_ip46list_t const *servers, uint32 options, char const *q, unsigned int qlen, uint16 qtype, tain_t const *deadline, tain_t const *stamp) </code> +<code> int s6dns_engine_init (s6dns_engine_t *dt, s6dns_ip46list_t const *servers, uint32_t options, char const *q, unsigned int qlen, uint16_t qtype, tain_t const *deadline, tain_t const *stamp) </code> </p> <p> diff --git a/doc/libs6dns/s6dns-fmt.html b/doc/libs6dns/s6dns-fmt.html index f77e925..7bd44b8 100644 --- a/doc/libs6dns/s6dns-fmt.html +++ b/doc/libs6dns/s6dns-fmt.html @@ -34,7 +34,7 @@ printable strings. <h2> Functions </h2> <p> -<code> unsigned int s6dns_fmt_domain (char *s, unsigned int max, s6dns_domain_t const *d) </code> <br /> +<code> size_t s6dns_fmt_domain (char *s, size_t max, s6dns_domain_t const *d) </code> <br /> Writes into string <em>s</em> the domain contained in *<em>d</em> (in string form). Returns the number of bytes written, or 0 in case of failure. If the output would be more than <em>max</em> bytes, 0 ENAMETOOLONG is returned. @@ -43,7 +43,7 @@ This function is actually an alias to <tt>s6dns_domain_tostring</tt>. </p> <p> -<code> unsigned int s6dns_fmt_domainlist (char *s, unsigned int max, s6dns_domain_t const *list, unsigned int n, char const *delin, unsigned int delimlen) </code> <br /> +<code> size_t s6dns_fmt_domainlist (char *s, size_t max, s6dns_domain_t const *list, unsigned int n, char const *delim, size_t delimlen) </code> <br /> Writes into string <em>s</em> the list of <em>n</em> domains (in string form) pointed to by <em>list</em>. Between each domain (and not after the last one), string <em>delim</em> of length <em>delimlen</em> is appended. @@ -53,7 +53,7 @@ To avoid that, S6DNS_FMT_DOMAINLIST(n) is a suitable number of bytes to prealloc </p> <p> -<code> unsigned int s6dns_fmt_hinfo (char *s, unsigned int max, s6dns_message_rr_hinfo_t const *p) </code> <br /> +<code> size_t s6dns_fmt_hinfo (char *s, size_t max, s6dns_message_rr_hinfo_t const *p) </code> <br /> Writes into string <em>s</em> the HINFO contained in *<em>p</em>: cpu, then os, separated by a space. Returns the number of bytes written, or 0 in case of failure. If @@ -62,7 +62,7 @@ To avoid that, S6DNS_FMT_HINFO is a suitable number of bytes to preallocate <em> </p> <p> -<code> unsigned int s6dns_fmt_mx (char *s, unsigned int max, s6dns_message_rr_mx_t const *p) </code> <br /> +<code> size_t s6dns_fmt_mx (char *s, size_t max, s6dns_message_rr_mx_t const *p) </code> <br /> Writes into string <em>s</em> the MX contained in *<em>p</em>: preference, then exchanger name, separated by a space. Returns the number of bytes written, or 0 in case of failure. If @@ -71,7 +71,7 @@ To avoid that, S6DNS_FMT_MX is a suitable number of bytes to preallocate <em>s</ </p> <p> -<code> unsigned int s6dns_fmt_soa (char *s, unsigned int max, s6dns_message_rr_soa_t const *p) </code> <br /> +<code> size_t s6dns_fmt_soa (char *s, size_t max, s6dns_message_rr_soa_t const *p) </code> <br /> Writes into string <em>s</em> the SOA contained in *<em>p</em>: mname, then rname, then serial number, refresh time, retry time, expiration time and minimum time, separated by spaces. @@ -81,7 +81,7 @@ To avoid that, S6DNS_FMT_SOA is a suitable number of bytes to preallocate <em>s< </p> <p> -<code> unsigned int s6dns_fmt_srv (char *s, unsigned int max, s6dns_message_rr_srv_t const *p) </code> <br /> +<code> size_t s6dns_fmt_srv (char *s, size_t max, s6dns_message_rr_srv_t const *p) </code> <br /> Writes into string <em>s</em> the SRV contained in *<em>p</em>: priority, then weight, then port, then target, separated by spaces. Returns the number of bytes written, or 0 in case of failure. If diff --git a/doc/libs6dns/s6dns-resolve.html b/doc/libs6dns/s6dns-resolve.html index bd770d3..e83d078 100644 --- a/doc/libs6dns/s6dns-resolve.html +++ b/doc/libs6dns/s6dns-resolve.html @@ -117,14 +117,14 @@ Returns 1 on success or 0 on failure. <h4> Generic resolution functions </h4> <p> -<code> int s6dns_resolve_core_g (s6dns_domain_t const *d, uint16 qtype, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_core_g (s6dns_domain_t const *d, uint16_t qtype, tain_t const *deadline) </code> <br /> Resolves the query on domain *<em>d</em> (in packet form), of type <em>qtype</em>. Returns 0 on failure, or 1 on success, in which case <tt>s6dns_engine_here</tt> contains the answer. </p> <p> -<code> int s6dns_resolve_parse_g (s6dns_domain_t const *d, uint16 qtype, s6dns_message_rr_func_t *f, void *data, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_parse_g (s6dns_domain_t const *d, uint16_t qtype, s6dns_message_rr_func_t *f, void *data, tain_t const *deadline) </code> <br /> Resolves the query on domain *<em>d</em> (in packet form), of type <em>qtype</em>, then parses the answer with function <em>f</em> and stores the result into <em>data</em>. Returns 1 if it succeeds, 0 if no data can be extracted from the answer, or -1 if an @@ -141,7 +141,7 @@ here as a return code of 0 with errno set to ENOENT. </p> <p> -<code> int s6dns_resolvenoq_g (char const *name, unsigned int len, uint16 qtype, s6dns_message_rr_func_t *f, void *data, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolvenoq_g (char const *name, size_t len, uint16_t qtype, s6dns_message_rr_func_t *f, void *data, tain_t const *deadline) </code> <br /> Performs a query of type <em>qtype</em> on name <em>name</em> of length <em>len</em>, without qualifying it. Parses the answer with function <em>f</em> and stores the result into <em>data</em>. Returns 1 if it succeeds, 0 if no data can be extracted, @@ -149,7 +149,7 @@ or -1 if an error occurs. Sets errno in the last two cases. </p> <p> -<code> int s6dns_resolveq_g (char const *name, unsigned int len, uint16 qtype, s6dns_message_rr_func_t *f, void *data, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolveq_g (char const *name, size_t len, uint16_t qtype, s6dns_message_rr_func_t *f, void *data, tain_t const *deadline) </code> <br /> Performs a query of type <em>qtype</em> on name <em>name</em> of length <em>len</em>, qualifying it first. Parses the answer with function <em>f</em> and stores the result into <em>data</em>. Returns 1 if it succeeds, 0 if none of the FQDNs can @@ -157,7 +157,7 @@ get a positive answer, or -1 if an error occurs. Sets errno in the last two case </p> <p> -<code> int s6dns_resolve_g (char const *name, unsigned int len, uint16 qtype, s6dns_message_rr_func_t *f, void *data, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_g (char const *name, size_t len, uint16_t qtype, s6dns_message_rr_func_t *f, void *data, int qualif, tain_t const *deadline) </code> <br /> Performs a query of type <em>qtype</em> on name <em>name</em> of length <em>len</em>. Qualifies <em>name</em> first if <em>qualif</em> is nonzero; else, does not qualify it. Parses the answer with function <em>f</em> and stores the @@ -168,7 +168,7 @@ get a positive answer, or -1 if an error occurs. Sets errno in the last two case <h4> High-level type-specific functions </h4> <p> -<code> int s6dns_resolve_a_g (stralloc *ips, char const *name, unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_a_g (stralloc *ips, char const *name, size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an A query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the IPs are @@ -176,7 +176,7 @@ appended to the stralloc *<em>ips</em>, using 4 bytes per answer. </p> <p> -<code> int s6dns_resolve_aaaa_g (stralloc *ips, char const *name, unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_aaaa_g (stralloc *ips, char const *name, size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an AAAA query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the IPs are @@ -184,7 +184,7 @@ appended to the stralloc *<em>ips</em>, using 16 bytes per answer. </p> <p> -<code> int s6dns_resolve_aaaaa_g (genalloc *ips, char const *name, unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_aaaaa_g (genalloc *ips, char const *name, size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an AAAA query and an A query at the same time on name <em>name</em> of length <em>len</em>, qualifying it first iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer @@ -196,7 +196,7 @@ indiscriminately. </p> <p> -<code> int s6dns_resolve_ptr_g (genalloc *ds, char const *name, unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_ptr_g (genalloc *ds, char const *name, size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs a PTR query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are @@ -228,7 +228,7 @@ depending on which <em>ip</em> is an IPv6 or IPv4 address. </p> <p> -<code> int s6dns_resolve_ns_g (genalloc *ds, char const *name, unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_ns_g (genalloc *ds, char const *name, size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs a NS query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are @@ -236,7 +236,7 @@ appended to the genalloc *<em>ds</em>, which contains an array of <tt>s6dns_doma </p> <p> -<code> int s6dns_resolve_cname_g (genalloc *ds, char const *name, unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +<code> int s6dns_resolve_cname_g (genalloc *ds, char const *name, size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs a CNAME query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are @@ -245,7 +245,7 @@ appended to the genalloc *<em>ds</em>, which contains an array of <tt>s6dns_doma <p> <code> int s6dns_resolve_hinfo_g (genalloc *hinfos, char const *name, -unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an HINFO query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are @@ -255,7 +255,7 @@ appended to the genalloc *<em>hinfos</em>, which contains an array of <p> <code> int s6dns_resolve_mx_g (genalloc *mxs, char const *name, -unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an MX query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are @@ -265,7 +265,7 @@ appended to the genalloc *<em>mxs</em>, which contains an array of <p> <code> int s6dns_resolve_soa_g (genalloc *soas, char const *name, -unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an SOA query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are @@ -275,7 +275,7 @@ appended to the genalloc *<em>soas</em>, which contains an array of <p> <code> int s6dns_resolve_srv_g (genalloc *srvs, char const *name, -unsigned int len, int qualif, tain_t const *deadline) </code> <br /> +size_t len, int qualif, tain_t const *deadline) </code> <br /> Performs an SRV query on name <em>name</em> of length <em>len</em>, qualifying it iff <em>qualif</em> is nonzero. Returns -1 if an error occurs, or 0 if no answer can be obtained from servers, or 1 if it succeeds, in which case the domains are |