1.\" @(#)rpc_xdr.3n 1.24 93/08/31 SMI; from SVr4 2.\" Copyright 1989 AT&T 3.\" @(#)rpc_xdr.new 1.1 89/04/06 SMI; 4.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved. 5.\" $NetBSD: rpc_xdr.3,v 1.4 2002/02/07 07:00:24 ross Exp $ 6.Dd May 3, 1993 7.Dt RPC_XDR 3 8.Os 9.Sh NAME 10.Nm xdr_accepted_reply , 11.Nm xdr_authsys_parms , 12.Nm xdr_callhdr , 13.Nm xdr_callmsg , 14.Nm xdr_opaque_auth , 15.Nm xdr_rejected_reply , 16.Nm xdr_replymsg 17.Nd XDR library routines for remote procedure calls 18.Sh LIBRARY 19.Lb libc 20.Sh SYNOPSIS 21.Fd #include \*[Lt]rpc/rpc.h\*[Gt] 22.Ft bool_t 23.Fn xdr_accepted_reply "XDR *xdrs" "const struct accepted_reply *ar" 24.Ft bool_t 25.Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp" 26.Ft void 27.Fn xdr_callhdr "XDR *xdrs" "struct rpc_msg *chdr" 28.Ft bool_t 29.Fn xdr_callmsg "XDR *xdrs" "struct rpc_msg *cmsg" 30.Ft bool_t 31.Fn xdr_opaque_auth "XDR *xdrs" "struct opaque_auth *ap" 32.Ft bool_t 33.Fn xdr_rejected_reply "XDR *xdrs" "const struct rejected_reply *rr" 34.Ft bool_t 35.Fn xdr_replymsg "XDR *xdrs" "const struct rpc_msg *rmsg" 36.Sh DESCRIPTION 37These routines are used for describing the 38RPC messages in XDR language. 39They should normally be used by those who do not 40want to use the RPC 41package directly. 42These routines return TRUE if they succeed, FALSE otherwise. 43.Sh ROUTINES 44See 45.Xr rpc 3 46for the definition of the 47.Vt XDR 48data structure. 49.Pp 50.Bl -tag -width XXXXX 51.It Fn xdr_accepted_reply 52Used to translate between RPC 53reply messages and their external representation. 54It includes the status of the RPC 55call in the XDR language format. 56In the case of success, it also includes the call results. 57.Pp 58.It Fn xdr_authsys_parms 59Used for describing UNIX operating system credentials. 60It includes machine-name, uid, gid list, etc. 61.Pp 62.It Fn xdr_callhdr 63Used for describing 64.SM RPC 65call header messages. 66It encodes the static part of the call message header in the 67XDR language format. 68It includes information such as transaction 69ID, RPC version number, program and version number. 70.Pp 71.It Fn xdr_callmsg 72Used for describing 73RPC call messages. 74This includes all the RPC 75call information such as transaction 76ID, RPC version number, program number, version number, 77authentication information, etc. 78This is normally used by servers to determine information about the client 79RPC call. 80.Pp 81.It Fn xdr_opaque_auth 82Used for describing RPC 83opaque authentication information messages. 84.Pp 85.It Fn xdr_rejected_reply 86Used for describing RPC reply messages. 87It encodes the rejected RPC message in the XDR language format. 88The message could be rejected either because of version 89number mis-match or because of authentication errors. 90.Pp 91.It Fn xdr_replymsg 92Used for describing RPC 93reply messages. It translates between the 94RPC reply message and its external representation. 95This reply could be either an acceptance, 96rejection or 97.Dv NULL . 98.El 99.Sh SEE ALSO 100.Xr rpc 3 , 101.Xr xdr 3 102