xref: /freebsd/lib/libc/rpc/rpc_xdr.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.Dd May 3, 1993
6.Dt RPC_XDR 3
7.Os
8.Sh NAME
9.Nm xdr_accepted_reply ,
10.Nm xdr_authsys_parms ,
11.Nm xdr_callhdr ,
12.Nm xdr_callmsg ,
13.Nm xdr_opaque_auth ,
14.Nm xdr_rejected_reply ,
15.Nm xdr_replymsg
16.Nd XDR library routines for remote procedure calls
17.Sh LIBRARY
18.Lb libc
19.Sh SYNOPSIS
20.In rpc/rpc.h
21.Ft bool_t
22.Fn xdr_accepted_reply "XDR *xdrs" "struct accepted_reply *ar"
23.Ft bool_t
24.Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp"
25.Ft bool_t
26.Fn xdr_callhdr "XDR *xdrs" "struct rpc_msg *chdr"
27.Ft bool_t
28.Fn xdr_callmsg "XDR *xdrs" "struct rpc_msg *cmsg"
29.Ft bool_t
30.Fn xdr_opaque_auth "XDR *xdrs" "struct opaque_auth *ap"
31.Ft bool_t
32.Fn xdr_rejected_reply "XDR *xdrs" "struct rejected_reply *rr"
33.Ft bool_t
34.Fn xdr_replymsg "XDR *xdrs" "struct rpc_msg *rmsg"
35.Sh DESCRIPTION
36These routines are used for describing the
37RPC messages in XDR language.
38They should normally be used by those who do not
39want to use the RPC
40package directly.
41These routines return
42.Dv TRUE
43if they succeed,
44.Dv FALSE
45otherwise.
46.Sh Routines
47See
48.Xr rpc 3
49for the definition of the
50.Vt XDR
51data structure.
52.Bl -tag -width XXXXX
53.It Fn xdr_accepted_reply
54Used to translate between RPC
55reply messages and their external representation.
56It includes the status of the RPC
57call in the XDR language format.
58In the case of success, it also includes the call results.
59.It Fn xdr_authsys_parms
60Used for describing
61.Ux
62operating system credentials.
63It includes machine-name, uid, gid list, etc.
64.It Fn xdr_callhdr
65Used for describing
66RPC
67call header messages.
68It encodes the static part of the call message header in the
69XDR language format.
70It includes information such as transaction
71ID, RPC version number, program and version number.
72.It Fn xdr_callmsg
73Used for describing
74RPC call messages.
75This includes all the RPC
76call information such as transaction
77ID, RPC version number, program number, version number,
78authentication information, etc.
79This is normally used by servers to determine information about the client
80RPC call.
81.It Fn xdr_opaque_auth
82Used for describing RPC
83opaque authentication information messages.
84.It Fn xdr_rejected_reply
85Used for describing RPC reply messages.
86It encodes the rejected RPC message in the XDR language format.
87The message could be rejected either because of version
88number mis-match or because of authentication errors.
89.It Fn xdr_replymsg
90Used for describing RPC
91reply messages.
92It translates between the
93RPC reply message and its external representation.
94This reply could be either an acceptance,
95rejection or
96.Dv NULL .
97.El
98.Sh SEE ALSO
99.Xr rpc 3 ,
100.Xr xdr 3
101