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