xref: /dflybsd-src/lib/libc/rpc/rpc_xdr.3 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" @(#)rpc_xdr.3n 1.24 93/08/31 SMI; from SVr4
286d7f5d3SJohn Marino.\" Copyright 1989 AT&T
386d7f5d3SJohn Marino.\" @(#)rpc_xdr.new 1.1 89/04/06 SMI;
486d7f5d3SJohn Marino.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
586d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/rpc/rpc_xdr.3,v 1.4 2005/02/09 18:03:14 ru Exp $
686d7f5d3SJohn Marino.Dd May 3, 1993
786d7f5d3SJohn Marino.Dt RPC_XDR 3
886d7f5d3SJohn Marino.Os
986d7f5d3SJohn Marino.Sh NAME
1086d7f5d3SJohn Marino.Nm xdr_accepted_reply ,
1186d7f5d3SJohn Marino.Nm xdr_authsys_parms ,
1286d7f5d3SJohn Marino.Nm xdr_callhdr ,
1386d7f5d3SJohn Marino.Nm xdr_callmsg ,
1486d7f5d3SJohn Marino.Nm xdr_opaque_auth ,
1586d7f5d3SJohn Marino.Nm xdr_rejected_reply ,
1686d7f5d3SJohn Marino.Nm xdr_replymsg
1786d7f5d3SJohn Marino.Nd XDR library routines for remote procedure calls
1886d7f5d3SJohn Marino.Sh LIBRARY
1986d7f5d3SJohn Marino.Lb libc
2086d7f5d3SJohn Marino.Sh SYNOPSIS
2186d7f5d3SJohn Marino.In rpc/rpc.h
2286d7f5d3SJohn Marino.Ft bool_t
2386d7f5d3SJohn Marino.Fn xdr_accepted_reply "XDR *xdrs" "struct accepted_reply *ar"
2486d7f5d3SJohn Marino.Ft bool_t
2586d7f5d3SJohn Marino.Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp"
2686d7f5d3SJohn Marino.Ft bool_t
2786d7f5d3SJohn Marino.Fn xdr_callhdr "XDR *xdrs" "struct rpc_msg *chdr"
2886d7f5d3SJohn Marino.Ft bool_t
2986d7f5d3SJohn Marino.Fn xdr_callmsg "XDR *xdrs" "struct rpc_msg *cmsg"
3086d7f5d3SJohn Marino.Ft bool_t
3186d7f5d3SJohn Marino.Fn xdr_opaque_auth "XDR *xdrs" "struct opaque_auth *ap"
3286d7f5d3SJohn Marino.Ft bool_t
3386d7f5d3SJohn Marino.Fn xdr_rejected_reply "XDR *xdrs" "struct rejected_reply *rr"
3486d7f5d3SJohn Marino.Ft bool_t
3586d7f5d3SJohn Marino.Fn xdr_replymsg "XDR *xdrs" "struct rpc_msg *rmsg"
3686d7f5d3SJohn Marino.Sh DESCRIPTION
3786d7f5d3SJohn MarinoThese routines are used for describing the
3886d7f5d3SJohn MarinoRPC messages in XDR language.
3986d7f5d3SJohn MarinoThey should normally be used by those who do not
4086d7f5d3SJohn Marinowant to use the RPC
4186d7f5d3SJohn Marinopackage directly.
4286d7f5d3SJohn MarinoThese routines return
4386d7f5d3SJohn Marino.Dv TRUE
4486d7f5d3SJohn Marinoif they succeed,
4586d7f5d3SJohn Marino.Dv FALSE
4686d7f5d3SJohn Marinootherwise.
4786d7f5d3SJohn Marino.Sh Routines
4886d7f5d3SJohn MarinoSee
4986d7f5d3SJohn Marino.Xr rpc 3
5086d7f5d3SJohn Marinofor the definition of the
5186d7f5d3SJohn Marino.Vt XDR
5286d7f5d3SJohn Marinodata structure.
5386d7f5d3SJohn Marino.Bl -tag -width XXXXX
5486d7f5d3SJohn Marino.It Fn xdr_accepted_reply
5586d7f5d3SJohn MarinoUsed to translate between RPC
5686d7f5d3SJohn Marinoreply messages and their external representation.
5786d7f5d3SJohn MarinoIt includes the status of the RPC
5886d7f5d3SJohn Marinocall in the XDR language format.
5986d7f5d3SJohn MarinoIn the case of success, it also includes the call results.
6086d7f5d3SJohn Marino.It Fn xdr_authsys_parms
6186d7f5d3SJohn MarinoUsed for describing
6286d7f5d3SJohn Marino.Ux
6386d7f5d3SJohn Marinooperating system credentials.
6486d7f5d3SJohn MarinoIt includes machine-name, uid, gid list, etc.
6586d7f5d3SJohn Marino.It Fn xdr_callhdr
6686d7f5d3SJohn MarinoUsed for describing
6786d7f5d3SJohn MarinoRPC
6886d7f5d3SJohn Marinocall header messages.
6986d7f5d3SJohn MarinoIt encodes the static part of the call message header in the
7086d7f5d3SJohn MarinoXDR language format.
7186d7f5d3SJohn MarinoIt includes information such as transaction
7286d7f5d3SJohn MarinoID, RPC version number, program and version number.
7386d7f5d3SJohn Marino.It Fn xdr_callmsg
7486d7f5d3SJohn MarinoUsed for describing
7586d7f5d3SJohn MarinoRPC call messages.
7686d7f5d3SJohn MarinoThis includes all the RPC
7786d7f5d3SJohn Marinocall information such as transaction
7886d7f5d3SJohn MarinoID, RPC version number, program number, version number,
7986d7f5d3SJohn Marinoauthentication information, etc.
8086d7f5d3SJohn MarinoThis is normally used by servers to determine information about the client
8186d7f5d3SJohn MarinoRPC call.
8286d7f5d3SJohn Marino.It Fn xdr_opaque_auth
8386d7f5d3SJohn MarinoUsed for describing RPC
8486d7f5d3SJohn Marinoopaque authentication information messages.
8586d7f5d3SJohn Marino.It Fn xdr_rejected_reply
8686d7f5d3SJohn MarinoUsed for describing RPC reply messages.
8786d7f5d3SJohn MarinoIt encodes the rejected RPC message in the XDR language format.
8886d7f5d3SJohn MarinoThe message could be rejected either because of version
8986d7f5d3SJohn Marinonumber mis-match or because of authentication errors.
9086d7f5d3SJohn Marino.It Fn xdr_replymsg
9186d7f5d3SJohn MarinoUsed for describing RPC
9286d7f5d3SJohn Marinoreply messages.
9386d7f5d3SJohn MarinoIt translates between the
9486d7f5d3SJohn MarinoRPC reply message and its external representation.
9586d7f5d3SJohn MarinoThis reply could be either an acceptance,
9686d7f5d3SJohn Marinorejection or
9786d7f5d3SJohn Marino.Dv NULL .
9886d7f5d3SJohn Marino.El
9986d7f5d3SJohn Marino.Sh SEE ALSO
10086d7f5d3SJohn Marino.Xr rpc 3 ,
10186d7f5d3SJohn Marino.Xr xdr 3
102