diff options
author | 1998-02-24 11:05:17 +0000 | |
---|---|---|
committer | 1998-02-24 11:05:17 +0000 | |
commit | 644e286ecd5ee1769556e3c0a44d818a90618462 (patch) | |
tree | c1828a9a900a9535e4145b2018288f1e93beee82 /lib/libc | |
parent | add new flags for global NIC access; wollman (diff) | |
download | wireguard-openbsd-644e286ecd5ee1769556e3c0a44d818a90618462.tar.xz wireguard-openbsd-644e286ecd5ee1769556e3c0a44d818a90618462.zip |
mandocmania
Diffstat (limited to 'lib/libc')
-rw-r--r-- | lib/libc/rpc/xdr.3 | 992 |
1 files changed, 357 insertions, 635 deletions
diff --git a/lib/libc/rpc/xdr.3 b/lib/libc/rpc/xdr.3 index 806e11e415a..f87aca48d67 100644 --- a/lib/libc/rpc/xdr.3 +++ b/lib/libc/rpc/xdr.3 @@ -1,816 +1,538 @@ -.\" $OpenBSD: xdr.3,v 1.3 1996/08/19 08:32:00 tholo Exp $ +.\" $OpenBSD: xdr.3,v 1.4 1998/02/24 11:05:17 deraadt Exp $ +.\" Mostly converted to mandoc by Theo de Raadt, Tue Feb 24 04:04:46 MST 1998 .\" -.TH XDR 3N "16 February 1988" -.SH NAME -xdr \- library routines for external data representation -.SH SYNOPSIS AND DESCRIPTION -.LP +.Dd February 16, 1988 +.Dt XDR 3 +.Os +.Sh NAME +.Nm xdr_array +.Nm xdr_bool +.Nm xdr_bytes +.Nm xdr_char +.Nm xdr_destroy +.Nm xdr_double +.Nm xdr_enum +.Nm xdr_float +.Nm xdr_free +.Nm xdr_getpos +.Nm xdr_inline +.Nm xdr_int +.Nm xdr_long +.Nm xdrmem_create +.Nm xdr_opaque +.Nm xdr_pointer +.Nm xdrrec_create +.Nm xdrrec_endofrecord +.Nm xdrrec_eof +.Nm xdrrec_skiprecord +.Nm xdr_reference +.Nm xdr_setpos +.Nm xdr_short +.Nm xdrstdio_create +.Nm xdr_string +.Nm xdr_u_char +.Nm xdr_u_int +.Nm xdr_u_long +.Nm xdr_u_short +.Nm xdr_union +.Nm xdr_vector +.Nm xdr_void +.Nm xdr_wrapstring +.Nd library routines for external data representation +.Sh SYNOPSIS +.Ft int +.Fn xdr_array "XDR *xdrs" "char **arrp" "u_int *sizep" "u_int maxsize" "u_int elsize" "xdrproc_t elproc" +.Ft int +.Fn xdr_bool "XDR *xdrs" "bool_t *bp" +.Ft int +.Fn xdr_bytes "XDR *xdrs" "char **sp" "u_int *sizep" "u_int maxsize" +.Ft int +.Fn xdr_char "XDR *xdrs" "char *cp" +.Ft void +.Fn xdr_destroy "XDR *xdrs" +.Ft int +.Fn xdr_double "XDR *xdrs" "double *dp" +.Ft int +.Fn xdr_enum "XDR *xdrs" "enum_t *ep" +.Ft int +.Fn xdr_float "XDR *xdrs" "float *fp" +.Ft void +.Fn xdr_free "xdrproc_t proc" "char *objp" +.Ft u_int +.Fn xdr_getpos "XDR *xdrs" +.Ft long * +.Fn xdr_inline "XDR *xdrs" "int len" +.Ft int +.Fn xdr_int "XDR *xdrs" "int *ip" +.Ft int +.Fn xdr_long "XDR *xdrs" "long *lp" +.Ft void +.Fn xdrmem_create "XDR *xdrs" "char *addr" "u_int size" "enum xdr_op op" +.Ft int +.Fn xdr_opaque "XDR *xdrs" "char *cp" "u_int cnt" +.Ft int +.Fn xdr_pointer "XDR *xdrs" "char **objpp" "u_int objsize" "xdrproc_t xdrobj" +.Ft void +.Fn xdrrec_create "XDR *xdrs" "u_int sendsize" "u_int recvsize" "char *handle" "int (*readit)()" "int (*writeit)()" +.Ft int +.Fn xdrrec_endofrecord "XDR *xdrs" "int sendnow" +.Ft int +.Fn xdrrec_eof "XDR *xdrs" "int empty" +.Ft int +.Fn xdrrec_skiprecord "XDR *xdrs" +.Ft int +.Fn xdr_reference "XDR *xdrs" "char **pp" "u_int size" "xdrproc_t proc" +.Ft int +.Fn xdr_setpos "XDR *xdrs" "u_int pos" +.Ft int +.Fn xdr_short "XDR *xdrs" "short *sp" +.Ft void +.Fn xdrstdio_create "XDR *xdrs" "FILE *file" "enum xdr_op op" +.Ft int +.Fn xdr_string "XDR *xdrs" "char **sp" "u_int maxsize" +.Ft int +.Fn xdr_u_char "XDR *xdrs" "unsigned char *ucp" +.Ft int +.Fn xdr_u_int "XDR *xdrs" "unsigned int *up" +.Ft int +.Fn xdr_u_long "XDR *xdrs" "unsigned long *ulp" +.Ft int +.Fn xdr_u_short "XDR *xdrs" "unsigned short *usp" +.Ft int +.Fn xdr_union "XDR *xdrs" "int *dscmp" "char *unp" "struct xdr_discrim *choices" "bool_t (*defaultarm)()" +.Ft int +.Fn xdr_vector "XDR *xdrs" "char *arrp" "u_int size" "u_int elsize" "xdrproc_t elproc" +.Ft int +.Fn xdr_void "void" +.Ft int +.Fn xdr_wrapstring "XDR *xdrs" "char **sp" +.Sh DESCRIPTION These routines allow C programmers to describe arbitrary data structures in a machine-independent fashion. Data for remote procedure calls are transmitted using these routines. -.LP -.ft B -.nf -.sp .5 -xdr_array(xdrs, arrp, sizep, maxsize, elsize, elproc) -\s-1XDR\s0 *xdrs; -char **arrp; -u_int *sizep, maxsize, elsize; -xdrproc_t elproc; -.fi -.ft R -.IP -A filter primitive that translates between variable-length -arrays -and their corresponding external representations. The -parameter -.I arrp +.Pp +.Fn xdr_array +is a filter primitive that translates between variable-length arrays +and their corresponding external representations. The parameter +.Fa arrp is the address of the pointer to the array, while -.I sizep +.Fa sizep is the address of the element count of the array; this element count cannot exceed -.IR maxsize . +.Fa maxsize . The parameter -.I elsize -is the -.I sizeof -each of the array's elements, and -.I elproc +.Fa elsize +is the size of each of the array's elements, and +.Fa elproc is an -.SM XDR +.Tn XDR filter that translates between the array elements' C form, and their external representation. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -xdr_bool(xdrs, bp) -\s-1XDR\s0 *xdrs; -bool_t *bp; -.fi -.ft R -.IP -A filter primitive that translates between booleans (C -integers) +.Pp +.Fn xdr_bool +is a filter primitive that translates between booleans (C integers) and their external representations. When encoding data, this filter produces values of either one or zero. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 10 -.LP -.ft B -.nf -.sp .5 -xdr_bytes(xdrs, sp, sizep, maxsize) -\s-1XDR\s0 *xdrs; -char **sp; -u_int *sizep, maxsize; -.fi -.ft R -.IP -A filter primitive that translates between counted byte +.Pp +.Fn xdr_bytes +is a filter primitive that translates between counted byte strings and their external representations. The parameter -.I sp +.Fa sp is the address of the string pointer. The length of the string is located at address -.IR sizep ; +.Fa sizep ; strings cannot be longer than -.IR maxsize . +.Fa maxsize . This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_char(xdrs, cp) -\s-1XDR\s0 *xdrs; -char *cp; -.fi -.ft R -.IP -A filter primitive that translates between C characters +.Pp +.Fn xdr_char +is a filter primitive that translates between C characters and their external representations. This routine returns one if it succeeds, zero otherwise. Note: encoded characters are not packed, and occupy 4 bytes each. For arrays of characters, it is worthwhile to consider -.BR xdr_bytes(\|) , -.B xdr_opaque(\|) +.Fn xdr_bytes , +.Fn xdr_opaque , or -.BR xdr_string(\|) . -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -void -xdr_destroy(xdrs) -\s-1XDR\s0 *xdrs; -.fi -.ft R -.IP -A macro that invokes the destroy routine associated with the -.SM XDR -stream, -.IR xdrs . +.Fn xdr_string . +.Pp +.Fn xdr_destroy +is a macro that invokes the destroy routine associated with the +.Tn XDR +stream +.Fa xdrs . Destruction usually involves freeing private data structures associated with the stream. Using -.I xdrs +.Fa xdrs after invoking -.B xdr_destroy(\|) +.Fn xdr_destroy is undefined. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_double(xdrs, dp) -\s-1XDR\s0 *xdrs; -double *dp; -.fi -.ft R -.IP -A filter primitive that translates between C -.B double +.Pp +.Fn xdr_double +is a filter primitive that translates between C +.Ft double precision numbers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_enum(xdrs, ep) -\s-1XDR\s0 *xdrs; -enum_t *ep; -.fi -.ft R -.IP -A filter primitive that translates between C -.BR enum s -(actually integers) and their external representations. +.Pp +.Fn xdr_enum +is a filter primitive that translates between the C +.Ft enum +type (actually an integer) and its external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -xdr_float(xdrs, fp) -\s-1XDR\s0 *xdrs; -float *fp; -.fi -.ft R -.IP -A filter primitive that translates between C -.BR float s -and their external representations. +.Pp +.Fn xdr_float +is a filter primitive that translates between the C +.Ft float +type and its external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 9 -.LP -.ft B -.nf -.sp .5 -void -xdr_free(proc, objp) -xdrproc_t proc; -char *objp; -.fi -.ft R -.IP -Generic freeing routine. The first argument is the -.SM XDR +.Pp +.Fn xdr_free +is a generic freeing routine. The first argument is the +.Tn XDR routine for the object being freed. The second argument -is a pointer to the object itself. Note: the pointer passed +is a pointer to the object itself. Note: the pointer passed to this routine is -.I not -freed, but what it points to -.I is -freed (recursively). -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -u_int -xdr_getpos(xdrs) -\s-1XDR\s0 *xdrs; -.fi -.ft R -.IP -A macro that invokes the get-position routine -associated with the -.SM XDR -stream, -.IR xdrs . +.Fa not +freed, but what it points to is freed (recursively). +.Pp +.Fn xdr_getpos +is a macro that invokes the get-position routine associated with the +.Tn XDR +stream +.Fa xdrs . The routine returns an unsigned integer, which indicates the position of the -.SM XDR +.Tn XDR byte stream. A desirable feature of -.SM XDR +.Tn XDR streams is that simple arithmetic works with this number, although the -.SM XDR +.Tn XDR stream instances need not guarantee this. -.br -.if t .ne 4 -.LP -.ft B -.nf -.sp .5 -.br -long * -xdr_inline(xdrs, len) -\s-1XDR\s0 *xdrs; -int len; -.fi -.ft R -.IP -A macro that invokes the in-line routine associated with the -.SM XDR -stream, -.IR xdrs . +.Pp +.Fn xdr_inline +is a macro that invokes the in-line routine associated with the +.Tn XDR +stream +.Fa xdrs . The routine returns a pointer to a contiguous piece of the stream's buffer; -.I len +.Fa len is the byte length of the desired buffer. Note: pointer is cast to -.BR "long *" . -.IP +.Ft "long *" . Warning: -.B xdr_inline(\|) +.Fn xdr_inline may return -.SM NULL -(0) +.Tn NULL if it cannot allocate a contiguous piece of a buffer. Therefore the behavior may vary among stream instances; it exists for the sake of efficiency. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_int(xdrs, ip) -\s-1XDR\s0 *xdrs; -int *ip; -.fi -.ft R -.IP -A filter primitive that translates between C integers +.Pp +.Fn xdr_int +is a filter primitive that translates between C integers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_long(xdrs, lp) -\s-1XDR\s0 *xdrs; -long *lp; -.fi -.ft R -.IP -A filter primitive that translates between C -.B long +.Pp +.Fn xdr_long +is a filter primitive that translates between C +.Ft long integers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 12 -.LP -.ft B -.nf -.sp .5 -void -xdrmem_create(xdrs, addr, size, op) -\s-1XDR\s0 *xdrs; -char *addr; -u_int size; -enum xdr_op op; -.fi -.ft R -.IP -This routine initializes the -.SM XDR +.Pp +.Fn xdrmem_create +is a routine which initializes the +.Tn XDR stream object pointed to by -.IR xdrs . +.Fa xdrs . The stream's data is written to, or read from, a chunk of memory at location -.I addr +.Fa addr whose length is no more than -.I size +.Fa size bytes long. The -.I op +.Fa op determines the direction of the -.SM XDR +.Tn XDR stream (either -.BR \s-1XDR_ENCODE\s0 , -.BR \s-1XDR_DECODE\s0 , +.Tn XDR_ENCODE , +.Tn XDR_DECODE , or -.BR \s-1XDR_FREE\s0 ). -.br -.if t .ne 10 -.LP -.ft B -.nf -.sp .5 -xdr_opaque(xdrs, cp, cnt) -\s-1XDR\s0 *xdrs; -char *cp; -u_int cnt; -.fi -.ft R -.IP -A filter primitive that translates between fixed size opaque +.Tn XDR_FREE Ns ). +.Pp +.Fn xdr_opaque +is a filter primitive that translates between fixed size opaque data and its external representation. The parameter -.I cp +.Fa cp is the address of the opaque object, and -.I cnt +.Fa cnt is its size in bytes. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 10 -.LP -.ft B -.nf -.sp .5 -xdr_pointer(xdrs, objpp, objsize, xdrobj) -\s-1XDR\s0 *xdrs; -char **objpp; -u_int objsize; -xdrproc_t xdrobj; -.fi -.ft R -.IP -Like -.B xdr_reference(\|) +.Pp +.Fn xdr_pointer +is like +.Fn xdr_reference execpt that it serializes -.SM NULL +.Tn NULL pointers, whereas -.B xdr_reference(\|) +.Fn xdr_reference does not. Thus, -.B xdr_pointer(\|) +.Fn xdr_pointer can represent recursive data structures, such as binary trees or linked lists. -.br -.if t .ne 15 -.LP -.ft B -.nf -.sp .5 -void -xdrrec_create(xdrs, sendsize, recvsize, handle, readit, writeit) -\s-1XDR\s0 *xdrs; -u_int sendsize, recvsize; -char *handle; -int (*readit) (\|), (*writeit) (\|); -.fi -.ft R -.IP -This routine initializes the -.SM XDR +.Pp +.Fn xdrrec_create +is a routine which initializes the +.Tn XDR stream object pointed to by -.IR xdrs . +.Fa xdrs . The stream's data is written to a buffer of size -.IR sendsize ; +.Fa sendsize ; a value of zero indicates the system should use a suitable default. The stream's data is read from a buffer of size -.IR recvsize ; +.Fa recvsize ; it too can be set to a suitable default by passing a zero value. When a stream's output buffer is full, -.I writeit +.Fn (*writeit) is called. Similarly, when a stream's input buffer is empty, -.I readit +.Fn (*readit) is called. The behavior of these two routines is similar to the system calls -.B read +.Fn read and -.BR write , +.Fn write , except that -.I handle +.Fa handle is passed to the former routines as the first parameter. Note: the -.SM XDR +.Tn XDR stream's -.I op +.Fa op field must be set by the caller. -.IP Warning: this -.SM XDR +.Tn XDR stream implements an intermediate record stream. Therefore there are additional bytes in the stream to provide record boundary information. -.br -.if t .ne 9 -.LP -.ft B -.nf -.sp .5 -xdrrec_endofrecord(xdrs, sendnow) -\s-1XDR\s0 *xdrs; -int sendnow; -.fi -.ft R -.IP -This routine can be invoked only on +.Pp +.Fn xdrrec_endofrecord +is a routine which can be invoked only on streams created by -.BR xdrrec_create(\|) . -The data in the output buffer is marked as a completed -record, +.Fn xdrrec_create . +The data in the output buffer is marked as a completed record, and the output buffer is optionally written out if -.I sendnow -is non-zero. This routine returns one if it succeeds, zero -otherwise. -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -xdrrec_eof(xdrs) -\s-1XDR\s0 *xdrs; -int empty; -.fi -.ft R -.IP -This routine can be invoked only on +.Fa sendnow +is non-zero. This routine returns one if it succeeds, zero otherwise. +.Pp +.Fn xdrrec_eof +is a routine which can be invoked only on streams created by -.BR xdrrec_create(\|) . +.Fn xdrrec_create . After consuming the rest of the current record in the stream, this routine returns one if the stream has no more input, zero otherwise. -.br -.if t .ne 3 -.LP -.ft B -.nf -.sp .5 -xdrrec_skiprecord(xdrs) -\s-1XDR\s0 *xdrs; -.fi -.ft R -.IP -This routine can be invoked only on +.Pp +.Fn xdrrec_skiprecord +is a routine which can be invoked only on streams created by -.BR xdrrec_create(\|) . +.Fn xdrrec_create . It tells the -.SM XDR +.Tn XDR implementation that the rest of the current record in the stream's input buffer should be discarded. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 11 -.LP -.ft B -.nf -.sp .5 -xdr_reference(xdrs, pp, size, proc) -\s-1XDR\s0 *xdrs; -char **pp; -u_int size; -xdrproc_t proc; -.fi -.ft R -.IP -A primitive that provides pointer chasing within structures. +.Pp +.Fn xdr_reference +is a primitive that provides pointer chasing within structures. The parameter -.I pp +.Fa pp is the address of the pointer; -.I size -is the -.I sizeof -the structure that -.I *pp +.Fa size +is the size of the structure that +.Fa *pp points to; and -.I proc +.Fa proc is an -.SM XDR +.Tn XDR procedure that filters the structure between its C form and its external representation. This routine returns one if it succeeds, zero otherwise. -.IP Warning: this routine does not understand -.SM NULL +.Tn NULL pointers. Use -.B xdr_pointer(\|) +.Fn xdr_pointer instead. -.br -.if t .ne 10 -.LP -.ft B -.nf -.sp .5 -xdr_setpos(xdrs, pos) -\s-1XDR\s0 *xdrs; -u_int pos; -.fi -.ft R -.IP -A macro that invokes the set position routine associated with -the -.SM XDR +.Pp +.Fn xdr_setpos +is a macro that invokes the set position routine associated with the +.Tn XDR stream -.IR xdrs . +.Fa xdrs . The parameter -.I pos +.Fa pos is a position value obtained from -.BR xdr_getpos(\|) . +.Fn xdr_getpos . This routine returns one if the -.SM XDR +.Tn XDR stream could be repositioned, and zero otherwise. -.IP Warning: it is difficult to reposition some types of -.SM XDR +.Tn XDR streams, so this routine may fail with one type of stream and succeed with another. -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -xdr_short(xdrs, sp) -\s-1XDR\s0 *xdrs; -short *sp; -.fi -.ft R -.IP -A filter primitive that translates between C -.B short +.Pp +.Fn xdr_short +is a filter primitive that translates between C +.Ft short integers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 10 -.LP -.ft B -.nf -.sp .5 -void -xdrstdio_create(xdrs, file, op) -\s-1XDR\s0 *xdrs; -\s-1FILE\s0 *file; -enum xdr_op op; -.fi -.ft R -.IP -This routine initializes the -.SM XDR +.Pp +.Fn xdrstdio_create +is a routine which initializes the +.Tn XDR stream object pointed to by -.IR xdrs . +.Fa xdrs . The -.SM XDR -stream data is written to, or read from, the Standard -.B I/O +.Tn XDR +stream data is written to, or read from, the Standard I/O stream -.IR file . +.Fa file . The parameter -.I op +.Fa op determines the direction of the -.SM XDR +.Tn XDR stream (either -.BR \s-1XDR_ENCODE\s0 , -.BR \s-1XDR_DECODE\s0 , +.Tn XDR_ENCODE , +.Tn XDR_DECODE , or -.BR \s-1XDR_FREE\s0 ). -.IP +.Tn XDR_FREE Ns ). Warning: the destroy routine associated with such -.SM XDR +.Tn XDR streams calls -.B fflush(\|) +.Fn fflush on the -.I file +.Fa file stream, but never -.BR fclose(\|) . -.br -.if t .ne 9 -.LP -.ft B -.nf -.sp .5 -xdr_string(xdrs, sp, maxsize) -\s-1XDR\s0 -*xdrs; -char **sp; -u_int maxsize; -.fi -.ft R -.IP -A filter primitive that translates between C strings and -their -corresponding external representations. -Strings cannot be longer than -.IR maxsize . +.Fn fclose . +.Pp +.Fn xdr_string +is a filter primitive that translates between C strings and their +corresponding external representations. Strings cannot be longer than +.Fa maxsize . Note: -.I sp +.Fa sp is the address of the string's pointer. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 8 -.LP -.ft B -.nf -.sp .5 -xdr_u_char(xdrs, ucp) -\s-1XDR\s0 *xdrs; -unsigned char *ucp; -.fi -.ft R -.IP -A filter primitive that translates between -.B unsigned +.Pp +.Fn xdr_u_char +is a filter primitive that translates between +.Ft unsigned C characters and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 9 -.LP -.ft B -.nf -.sp .5 -xdr_u_int(xdrs, up) -\s-1XDR\s0 *xdrs; -unsigned *up; -.fi -.ft R -.IP -A filter primitive that translates between C -.B unsigned +.Pp +.Fn xdr_u_int +is a filter primitive that translates between C +.Ft unsigned integers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_u_long(xdrs, ulp) -\s-1XDR\s0 *xdrs; -unsigned long *ulp; -.fi -.ft R -.IP -A filter primitive that translates between C -.B "unsigned long" +.Pp +.Fn xdr_u_long +is a filter primitive that translates between C +.Ft "unsigned long" integers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 7 -.LP -.ft B -.nf -.sp .5 -xdr_u_short(xdrs, usp) -\s-1XDR\s0 *xdrs; -unsigned short *usp; -.fi -.ft R -.IP -A filter primitive that translates between C -.B "unsigned short" +.Pp +.Fn xdr_u_short +is a filter primitive that translates between C +.Ft "unsigned short" integers and their external representations. This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 16 -.LP -.ft B -.nf -.sp .5 -xdr_union(xdrs, dscmp, unp, choices, dfault) -\s-1XDR\s0 *xdrs; -int *dscmp; -char *unp; -struct xdr_discrim *choices; -bool_t (*defaultarm) (\|); /* may equal \s-1NULL\s0 */ -.fi -.ft R -.IP -A filter primitive that translates between a discriminated C -.B union +.Pp +.Fn xdr_union +is a filter primitive that translates between a discriminated C +.Ft union and its corresponding external representation. It first translates the discriminant of the union located at -.IR dscmp . +.Fa dscmp . This discriminant is always an -.BR enum_t . +.Ft enum_t . Next the union located at -.I unp +.Fa unp is translated. The parameter -.I choices +.Fa choices is a pointer to an array of -.B xdr_discrim(\|) +.Ft struct xdr_discrim structures. Each structure contains an ordered pair of -.RI [ value , proc ]. +.Ft [ value , proc ]. If the union's discriminant is equal to the associated -.IR value , +.Fa value , then the -.I proc +.Fa proc is called to translate the union. The end of the -.B xdr_discrim(\|) +.Fa struct xdr_discrim structure array is denoted by a routine of value -.SM NULL\s0. +.Tn NULL. If the discriminant is not found in the -.I choices +.Fa choices array, then the -.I defaultarm +.Fn (*defaultarm) procedure is called (if it is not -.SM NULL\s0). +.Tn NULL Ns ). Returns one if it succeeds, zero otherwise. -.br -.if t .ne 6 -.LP -.ft B -.nf -.sp .5 -xdr_vector(xdrs, arrp, size, elsize, elproc) -\s-1XDR\s0 *xdrs; -char *arrp; -u_int size, elsize; -xdrproc_t elproc; -.fi -.ft R -.IP -A filter primitive that translates between fixed-length -arrays -and their corresponding external representations. The -parameter -.I arrp +.Pp +.Fn xdr_vector +is a filter primitive that translates between fixed-length arrays +and their corresponding external representations. The parameter +.Fa arrp is the address of the pointer to the array, while -.I size +.Fa size is is the element count of the array. The parameter -.I elsize -is the -.I sizeof -each of the array's elements, and -.I elproc +.Fa elsize +is the size of each of the array's elements, and +.Fa elproc is an -.SM XDR -filter that translates between -the array elements' C form, and their external -representation. -This routine returns one if it succeeds, zero otherwise. -.br -.if t .ne 5 -.LP -.ft B -.nf -.sp .5 -xdr_void(\|) -.fi -.ft R -.IP -This routine always returns one. -It may be passed to -.SM RPC -routines that require a function parameter, -where nothing is to be done. -.br -.if t .ne 10 -.LP -.ft B -.nf -.sp .5 -xdr_wrapstring(xdrs, sp) -\s-1XDR\s0 *xdrs; -char **sp; -.fi -.ft R -.IP -A primitive that calls -.B "xdr_string(xdrs, sp,\s-1MAXUN.UNSIGNED\s0 );" +.Tn XDR +filter that translates between the array elements' C form, and their +external representation. This routine returns one if it succeeds, zero +otherwise. +.Pp +.Fn xdr_void +is a routine which always returns one. It may be passed to +.Tn RPC +routines that require a function parameter, but where nothing is to be done. +.Pp +.Fn xdr_wrapstring +is a primitive that calls +.B "xdr_string(xdrs, sp, MAXUN.UNSIGNED );" where .B -.SM MAXUN.UNSIGNED +.Tn MAXUN.UNSIGNED is the maximum value of an unsigned integer. -.B xdr_wrapstring(\|) +.Fn xdr_wrapstring is handy because the -.SM RPC +.Tn RPC package passes a maximum of two -.SM XDR +.Tn XDR routines as parameters, and -.BR xdr_string(\|) , +.Fn xdr_string , one of the most frequently used primitives, requires three. Returns one if it succeeds, zero otherwise. -.SH SEE ALSO -.BR rpc (3N) -.LP +.Sh SEE ALSO +.Xr rpc 3 . +.Pp The following manuals: .RS .ft I @@ -819,6 +541,6 @@ eXternal Data Representation Standard: Protocol Specification eXternal Data Representation: Sun Technical Notes .ft R .br -.IR "\s-1XDR\s0: External Data Representation Standard" , -.SM RFC1014, Sun Microsystems, Inc., -.SM USC-ISI\s0. +.Tn "XDR: External Data Representation Standard" , +.Tn RFC1014, Sun Microsystems, Inc., +.Tn USC-ISI. |