xdr_admin.3n (2010 09)
x
xdr_admin(3N) xdr_admin(3N)
NAME
xdr_admin, xdr_control, xdr_getpos, xdr_inline, xdrrec_endofrecord, xdrrec_eof, xdrrec_readbytes,
xdrrec_skiprecord, xdr_setpos, xdr_sizeof - library routines for external data representation
SYNOPSIS
#include <rpc/xdr.h>
bool_t xdr_control(XDR *
xdrs, int req, void *info
);
u_int xdr_getpos(const XDR *
xdrs);
long *xdr_inline(XDR *
xdrs, const int len);
bool_t xdrrec_endofrecord(XDR *
xdrs, int sendnow);
bool_t xdrrec_eof(XDR *
xdrs);
int xdrrec_readbytes(XDR *
xdrs, caddr_t
addr, u_int nbytes );
bool_t xdrrec_skiprecord(XDR *
xdrs);
bool_t xdr_setpos(XDR *
xdrs, const u_int pos);
unsigned long xdr_sizeof(xdrproc_t
func, void *
data );
DESCRIPTION
XDR library routines allow C programmers to describe arbitrary data structures in a machine-
independent fashion. Protocols such as remote procedure calls (RPC) use these routines to describe the
format of the data.
These routines deal specifically with the management of the XDR stream.
Routines
See rpc (3N) for the definition of the XDR data structure. Note that any buffers passed to the XDR rou-
tines must be properly aligned. It is suggested either that malloc (3C) be used to allocate these buffers or
that the programmer insure that the buffer address is divisible evenly by four.
bool_t xdr_control()
A function macro to change or retrieve various information about an XDR stream. req indicates the
type of operation and info is a pointer to the information. The supported value of req is
XDR_GET_BYTES_AVAIL
and its argument type is xdr_bytesrec *. It returns the number of
bytes left unconsumed in the stream and a flag indicating whether or not this is the last fragment.
u_int xdr_getpos()
A macro that invokes the get-position routine associated with the XDR stream, xdrs. The routine
returns an unsigned integer, which indicates the position of the XDR byte stream. A desirable
feature of XDR streams is that simple arithmetic works with this number, although the XDR stream
instances need not guarantee this. Therefore, applications written for portability should not depend
on this feature.
long *xdr_inline()
A macro that invokes the in-line routine associated with the XDR stream, xdrs. The routine returns
a pointer to a contiguous piece of the stream’s buffer; len is the byte length of the desired buffer.
Note: pointer is cast to long *.
Warning:
xdr_inline() may return NULL (0) 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, and
applications written for portability should not depend on this feature.
bool_t xdrrec_endofrecord()
This routine can be invoked only on streams created by xdrrec_create() (see xdr_create (3N)).
The data in the output buffer is marked as a completed record, and the output buffer is optionally
written out if sendnow is non-zero. This routine returns TRUE if it succeeds, FALSE otherwise.
bool_t xdrrec_eof()
This routine can be invoked only on streams created by xdrrec_create(). After consuming the
rest of the current record in the stream, this routine returns TRUE if there is no more data in the
stream’s input buffer. It returns FALSE if there is additional data in the stream’s input buffer.
int xdrrec_readbytes()
This routine can be invoked only on streams created by xdrrec_create(). It attempts to read
HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1