xref: /netbsd-src/lib/libc/rpc/rpc_xdr.3 (revision 3d2415a28fe8fe5d50669f9ed011856ce344ce84)
17df0ccbaSfvdl.\" @(#)rpc_xdr.3n 1.24 93/08/31 SMI; from SVr4
27df0ccbaSfvdl.\" Copyright 1989 AT&T
37df0ccbaSfvdl.\" @(#)rpc_xdr.new 1.1 89/04/06 SMI;
47df0ccbaSfvdl.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
5*3d2415a2Sjoerg.\" $NetBSD: rpc_xdr.3,v 1.8 2009/04/11 16:03:29 joerg Exp $
67df0ccbaSfvdl.Dd May 3, 1993
77df0ccbaSfvdl.Dt RPC_XDR 3
87df0ccbaSfvdl.Os
97df0ccbaSfvdl.Sh NAME
107df0ccbaSfvdl.Nm xdr_accepted_reply ,
117df0ccbaSfvdl.Nm xdr_authsys_parms ,
127df0ccbaSfvdl.Nm xdr_callhdr ,
137df0ccbaSfvdl.Nm xdr_callmsg ,
147df0ccbaSfvdl.Nm xdr_opaque_auth ,
157df0ccbaSfvdl.Nm xdr_rejected_reply ,
167df0ccbaSfvdl.Nm xdr_replymsg
177df0ccbaSfvdl.Nd XDR library routines for remote procedure calls
187df0ccbaSfvdl.Sh LIBRARY
197df0ccbaSfvdl.Lb libc
207df0ccbaSfvdl.Sh SYNOPSIS
21472351e1Swiz.In rpc/rpc.h
227df0ccbaSfvdl.Ft bool_t
237df0ccbaSfvdl.Fn xdr_accepted_reply "XDR *xdrs" "const struct accepted_reply *ar"
247df0ccbaSfvdl.Ft bool_t
257df0ccbaSfvdl.Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp"
267df0ccbaSfvdl.Ft void
277df0ccbaSfvdl.Fn xdr_callhdr "XDR *xdrs" "struct rpc_msg *chdr"
287df0ccbaSfvdl.Ft bool_t
297df0ccbaSfvdl.Fn xdr_callmsg "XDR *xdrs" "struct rpc_msg *cmsg"
307df0ccbaSfvdl.Ft bool_t
317df0ccbaSfvdl.Fn xdr_opaque_auth "XDR *xdrs" "struct opaque_auth *ap"
327df0ccbaSfvdl.Ft bool_t
337df0ccbaSfvdl.Fn xdr_rejected_reply "XDR *xdrs" "const struct rejected_reply *rr"
347df0ccbaSfvdl.Ft bool_t
357df0ccbaSfvdl.Fn xdr_replymsg "XDR *xdrs" "const struct rpc_msg *rmsg"
367df0ccbaSfvdl.Sh DESCRIPTION
377df0ccbaSfvdlThese routines are used for describing the
387df0ccbaSfvdlRPC messages in XDR language.
397df0ccbaSfvdlThey should normally be used by those who do not
407df0ccbaSfvdlwant to use the RPC
417df0ccbaSfvdlpackage directly.
427df0ccbaSfvdlThese routines return TRUE if they succeed, FALSE otherwise.
43723dbf64Swiz.Sh ROUTINES
447df0ccbaSfvdlSee
457df0ccbaSfvdl.Xr rpc 3
467df0ccbaSfvdlfor the definition of the
477df0ccbaSfvdl.Vt XDR
487df0ccbaSfvdldata structure.
497df0ccbaSfvdl.Pp
507df0ccbaSfvdl.Bl -tag -width XXXXX
517df0ccbaSfvdl.It Fn xdr_accepted_reply
527df0ccbaSfvdlUsed to translate between RPC
537df0ccbaSfvdlreply messages and their external representation.
547df0ccbaSfvdlIt includes the status of the RPC
557df0ccbaSfvdlcall in the XDR language format.
567df0ccbaSfvdlIn the case of success, it also includes the call results.
577df0ccbaSfvdl.Pp
587df0ccbaSfvdl.It Fn xdr_authsys_parms
597df0ccbaSfvdlUsed for describing UNIX operating system credentials.
607df0ccbaSfvdlIt includes machine-name, uid, gid list, etc.
617df0ccbaSfvdl.Pp
627df0ccbaSfvdl.It Fn xdr_callhdr
63*3d2415a2SjoergUsed for describing RPC call header messages.
647df0ccbaSfvdlIt encodes the static part of the call message header in the
657df0ccbaSfvdlXDR language format.
667df0ccbaSfvdlIt includes information such as transaction
677df0ccbaSfvdlID, RPC version number, program and version number.
687df0ccbaSfvdl.Pp
697df0ccbaSfvdl.It Fn xdr_callmsg
707df0ccbaSfvdlUsed for describing
717df0ccbaSfvdlRPC call messages.
727df0ccbaSfvdlThis includes all the  RPC
737df0ccbaSfvdlcall information such as transaction
747df0ccbaSfvdlID, RPC version number, program number, version number,
757df0ccbaSfvdlauthentication information, etc.
767df0ccbaSfvdlThis is normally used by servers to determine information about the client
777df0ccbaSfvdlRPC call.
787df0ccbaSfvdl.Pp
797df0ccbaSfvdl.It Fn xdr_opaque_auth
807df0ccbaSfvdlUsed for describing RPC
817df0ccbaSfvdlopaque authentication information messages.
827df0ccbaSfvdl.Pp
837df0ccbaSfvdl.It Fn xdr_rejected_reply
847df0ccbaSfvdlUsed for describing RPC reply messages.
857df0ccbaSfvdlIt encodes the rejected RPC message in the XDR language format.
867df0ccbaSfvdlThe message could be rejected either because of version
877df0ccbaSfvdlnumber mis-match or because of authentication errors.
887df0ccbaSfvdl.Pp
897df0ccbaSfvdl.It Fn xdr_replymsg
907df0ccbaSfvdlUsed for describing RPC
916569c5c5Swizreply messages.
926569c5c5SwizIt translates between the
937df0ccbaSfvdlRPC reply message and its external representation.
947df0ccbaSfvdlThis reply could be either an acceptance,
957df0ccbaSfvdlrejection or
967df0ccbaSfvdl.Dv NULL .
977df0ccbaSfvdl.El
987df0ccbaSfvdl.Sh SEE ALSO
997df0ccbaSfvdl.Xr rpc 3 ,
1007df0ccbaSfvdl.Xr xdr 3
101