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.\" $FreeBSD: src/lib/libc/rpc/rpc_xdr.3,v 1.4 2005/02/09 18:03:14 ru 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.In rpc/rpc.h 22.Ft bool_t 23.Fn xdr_accepted_reply "XDR *xdrs" "struct accepted_reply *ar" 24.Ft bool_t 25.Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp" 26.Ft bool_t 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" "struct rejected_reply *rr" 34.Ft bool_t 35.Fn xdr_replymsg "XDR *xdrs" "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 43.Dv TRUE 44if they succeed, 45.Dv FALSE 46otherwise. 47.Sh Routines 48See 49.Xr rpc 3 50for the definition of the 51.Vt XDR 52data structure. 53.Bl -tag -width XXXXX 54.It Fn xdr_accepted_reply 55Used to translate between RPC 56reply messages and their external representation. 57It includes the status of the RPC 58call in the XDR language format. 59In the case of success, it also includes the call results. 60.It Fn xdr_authsys_parms 61Used for describing 62.Ux 63operating system credentials. 64It includes machine-name, uid, gid list, etc. 65.It Fn xdr_callhdr 66Used for describing 67RPC 68call header messages. 69It encodes the static part of the call message header in the 70XDR language format. 71It includes information such as transaction 72ID, RPC version number, program and version number. 73.It Fn xdr_callmsg 74Used for describing 75RPC call messages. 76This includes all the RPC 77call information such as transaction 78ID, RPC version number, program number, version number, 79authentication information, etc. 80This is normally used by servers to determine information about the client 81RPC call. 82.It Fn xdr_opaque_auth 83Used for describing RPC 84opaque authentication information messages. 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.It Fn xdr_replymsg 91Used for describing RPC 92reply messages. 93It 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