← Back to branch summary

~ubuntu-branches/ubuntu/maverick/bind9/maverick

« back to all changes in this revision

Viewing changes to lib/lwres/man/lwres_packet.3

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones, LaMont Jones, Internet Software Consortium, Inc, localization folks
  • Date: 2008-08-02 14:20:20 UTC
  • mfrom: (1.2.1 upstream) (6.1.24 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080802142020-l1hon9jy8lbbjxmg
http://bugs.debian.org/149259
http://bugs.debian.org/492418
http://bugs.debian.org/493392
http://bugs.debian.org/492564
http://bugs.debian.org/490027
http://bugs.debian.org/492949
http://bugs.debian.org/492425
http://bugs.debian.org/491369
http://bugs.debian.org/492048
http://bugs.debian.org/490630
http://bugs.debian.org/492587
[LaMont Jones]

* default to using resolvconf if it is installed
* fix sonames and dependencies.  Closes: #149259, #492418
* Do not build-depend libcap2-dev on non-linux.  Closes: #493392
* drop unused query-loc manpage.  Closes: #492564
* lwresd: Deliver /etc/bind directory.  Closes: #490027
* fix query-source comment in default install

[Internet Software Consortium, Inc]

* 9.5.0-P2.  Closes: #492949

[localization folks]

* l10n: Spanish debconf translation.  Closes: #492425 (Ignacio Mondino)
* l10n: Swedish debconf templates.  Closes: #491369 (Martin Ågren)
* l10n: Japanese debconf translations.  Closes: #492048 (Hideki Yamane
  (Debian-JP))
* l10n: Finnish translation.  Closes: #490630 (Esko Arajärvi)
* l10n: Italian debconf translations.  Closes: #492587 (Alessandro Vietta)

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/lwres/man/lwres_packet.3
1
 
.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
 
1
.\" Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
2
2
.\" Copyright (C) 2000, 2001 Internet Software Consortium.
3
3
.\" 
4
4
.\" Permission to use, copy, modify, and distribute this software for any
13
13
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14
14
.\" PERFORMANCE OF THIS SOFTWARE.
15
15
.\"
16
 
.\" $Id: lwres_packet.3,v 1.15.2.1.8.5 2005/10/13 02:33:54 marka Exp $
 
16
.\" $Id: lwres_packet.3,v 1.29 2007/01/30 00:24:59 marka Exp $
17
17
.\"
18
18
.hy 0
19
19
.ad l
20
 
.\" ** You probably do not want to edit this file directly **
21
 
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
22
 
.\" Instead of manually editing it, you probably should edit the DocBook XML
23
 
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
 
20
.\"     Title: lwres_packet
 
21
.\"    Author: 
 
22
.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 
23
.\"      Date: Jun 30, 2000
 
24
.\"    Manual: BIND9
 
25
.\"    Source: BIND9
 
26
.\"
24
27
.TH "LWRES_PACKET" "3" "Jun 30, 2000" "BIND9" "BIND9"
25
28
.\" disable hyphenation
26
29
.nh
33
36
#include <lwres/lwpacket.h>
34
37
.fi
35
38
.HP 43
36
 
\fBlwres_result_t\ \fBlwres_lwpacket_renderheader\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB);\fR
 
39
.BI "lwres_result_t lwres_lwpacket_renderheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");"
37
40
.HP 42
38
 
\fBlwres_result_t\ \fBlwres_lwpacket_parseheader\fR\fR\fB(\fR\fBlwres_buffer_t\ *b\fR\fB, \fR\fBlwres_lwpacket_t\ *pkt\fR\fB);\fR
 
41
.BI "lwres_result_t lwres_lwpacket_parseheader(lwres_buffer_t\ *" "b" ", lwres_lwpacket_t\ *" "pkt" ");"
39
42
.SH "DESCRIPTION"
40
43
.PP
41
44
These functions rely on a
42
45
\fBstruct lwres_lwpacket\fR
43
46
which is defined in
44
47
\fIlwres/lwpacket.h\fR.
45
 
.sp
 
48
.PP
 
49
.RS 4
46
50
.nf
47
51
typedef struct lwres_lwpacket lwres_lwpacket_t;
 
52
.fi
 
53
.RE
 
54
.sp
 
55
.PP
 
56
.RS 4
 
57
.nf
48
58
struct lwres_lwpacket {
49
59
        lwres_uint32_t          length;
50
60
        lwres_uint16_t          version;
57
67
        lwres_uint16_t          authlength;
58
68
};
59
69
.fi
 
70
.RE
60
71
.sp
61
72
.PP
62
73
The elements of this structure are:
63
 
.TP
 
74
.PP
64
75
\fBlength\fR
 
76
.RS 4
65
77
the overall packet length, including the entire packet header. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
66
 
.TP
 
78
.RE
 
79
.PP
67
80
\fBversion\fR
 
81
.RS 4
68
82
the header format. There is currently only one format,
69
83
\fBLWRES_LWPACKETVERSION_0\fR. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
70
 
.TP
 
84
.RE
 
85
.PP
71
86
\fBpktflags\fR
 
87
.RS 4
72
88
library\-defined flags for this packet: for instance whether the packet is a request or a reply. Flag values can be set, but not defined by the caller. This field is filled in by the application wit the exception of the LWRES_LWPACKETFLAG_RESPONSE bit, which is set by the library in the lwres_gabn_*() and lwres_gnba_*() calls.
73
 
.TP
 
89
.RE
 
90
.PP
74
91
\fBserial\fR
 
92
.RS 4
75
93
is set by the requestor and is returned in all replies. If two or more packets from the same source have the same serial number and are from the same source, they are assumed to be duplicates and the latter ones may be dropped. This field must be set by the application.
76
 
.TP
 
94
.RE
 
95
.PP
77
96
\fBopcode\fR
 
97
.RS 4
78
98
indicates the operation. Opcodes between 0x00000000 and 0x03ffffff are reserved for use by the lightweight resolver library. Opcodes between 0x04000000 and 0xffffffff are application defined. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
79
 
.TP
 
99
.RE
 
100
.PP
80
101
\fBresult\fR
 
102
.RS 4
81
103
is only valid for replies. Results between 0x04000000 and 0xffffffff are application defined. Results between 0x00000000 and 0x03ffffff are reserved for library use. This field is filled in by the lwres_gabn_*() and lwres_gnba_*() calls.
82
 
.TP
 
104
.RE
 
105
.PP
83
106
\fBrecvlength\fR
 
107
.RS 4
84
108
is the maximum buffer size that the receiver can handle on requests and the size of the buffer needed to satisfy a request when the buffer is too large for replies. This field is supplied by the application.
85
 
.TP
 
109
.RE
 
110
.PP
86
111
\fBauthtype\fR
 
112
.RS 4
87
113
defines the packet level authentication that is used. Authorisation types between 0x1000 and 0xffff are application defined and types between 0x0000 and 0x0fff are reserved for library use. Currently these are not used and must be zero.
88
 
.TP
 
114
.RE
 
115
.PP
89
116
\fBauthlen\fR
 
117
.RS 4
90
118
gives the length of the authentication data. Since packet authentication is currently not used, this must be zero.
 
119
.RE
91
120
.PP
92
121
The following opcodes are currently defined:
93
 
.TP
 
122
.PP
94
123
\fBNOOP\fR
 
124
.RS 4
95
125
Success is always returned and the packet contents are echoed. The lwres_noop_*() functions should be used for this type.
96
 
.TP
 
126
.RE
 
127
.PP
97
128
\fBGETADDRSBYNAME\fR
 
129
.RS 4
98
130
returns all known addresses for a given name. The lwres_gabn_*() functions should be used for this type.
99
 
.TP
 
131
.RE
 
132
.PP
100
133
\fBGETNAMEBYADDR\fR
 
134
.RS 4
101
135
return the hostname for the given address. The lwres_gnba_*() functions should be used for this type.
 
136
.RE
102
137
.PP
103
138
\fBlwres_lwpacket_renderheader()\fR
104
139
transfers the contents of lightweight resolver packet structure
105
 
\fBlwres_lwpacket_t\fR\fI*pkt\fR
 
140
\fBlwres_lwpacket_t\fR
 
141
\fI*pkt\fR
106
142
in network byte order to the lightweight resolver buffer,
107
143
\fI*b\fR.
108
144
.PP
127
163
\fI*pkt\fR
128
164
both functions return
129
165
\fBLWRES_R_UNEXPECTEDEND\fR.
 
166
.SH "COPYRIGHT"
 
167
Copyright \(co 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
 
168
.br
 
169
Copyright \(co 2000, 2001 Internet Software Consortium.
 
170
.br