xref: /freebsd/lib/libc/rpc/rpc_xdr.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
18360efbdSAlfred Perlstein.\" Copyright 1989 AT&T
28360efbdSAlfred Perlstein.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
38360efbdSAlfred Perlstein.Dd May 3, 1993
48360efbdSAlfred Perlstein.Dt RPC_XDR 3
58360efbdSAlfred Perlstein.Os
68360efbdSAlfred Perlstein.Sh NAME
78360efbdSAlfred Perlstein.Nm xdr_accepted_reply ,
88360efbdSAlfred Perlstein.Nm xdr_authsys_parms ,
98360efbdSAlfred Perlstein.Nm xdr_callhdr ,
108360efbdSAlfred Perlstein.Nm xdr_callmsg ,
118360efbdSAlfred Perlstein.Nm xdr_opaque_auth ,
128360efbdSAlfred Perlstein.Nm xdr_rejected_reply ,
138360efbdSAlfred Perlstein.Nm xdr_replymsg
148360efbdSAlfred Perlstein.Nd XDR library routines for remote procedure calls
158360efbdSAlfred Perlstein.Sh LIBRARY
168360efbdSAlfred Perlstein.Lb libc
178360efbdSAlfred Perlstein.Sh SYNOPSIS
1832eef9aeSRuslan Ermilov.In rpc/rpc.h
198360efbdSAlfred Perlstein.Ft bool_t
20db7534cfSBruce Evans.Fn xdr_accepted_reply "XDR *xdrs" "struct accepted_reply *ar"
218360efbdSAlfred Perlstein.Ft bool_t
228360efbdSAlfred Perlstein.Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp"
23db7534cfSBruce Evans.Ft bool_t
248360efbdSAlfred Perlstein.Fn xdr_callhdr "XDR *xdrs" "struct rpc_msg *chdr"
258360efbdSAlfred Perlstein.Ft bool_t
268360efbdSAlfred Perlstein.Fn xdr_callmsg "XDR *xdrs" "struct rpc_msg *cmsg"
278360efbdSAlfred Perlstein.Ft bool_t
288360efbdSAlfred Perlstein.Fn xdr_opaque_auth "XDR *xdrs" "struct opaque_auth *ap"
298360efbdSAlfred Perlstein.Ft bool_t
30db7534cfSBruce Evans.Fn xdr_rejected_reply "XDR *xdrs" "struct rejected_reply *rr"
318360efbdSAlfred Perlstein.Ft bool_t
32db7534cfSBruce Evans.Fn xdr_replymsg "XDR *xdrs" "struct rpc_msg *rmsg"
338360efbdSAlfred Perlstein.Sh DESCRIPTION
348360efbdSAlfred PerlsteinThese routines are used for describing the
358360efbdSAlfred PerlsteinRPC messages in XDR language.
368360efbdSAlfred PerlsteinThey should normally be used by those who do not
378360efbdSAlfred Perlsteinwant to use the RPC
388360efbdSAlfred Perlsteinpackage directly.
398360efbdSAlfred PerlsteinThese routines return
408360efbdSAlfred Perlstein.Dv TRUE
418360efbdSAlfred Perlsteinif they succeed,
428360efbdSAlfred Perlstein.Dv FALSE
438360efbdSAlfred Perlsteinotherwise.
448360efbdSAlfred Perlstein.Sh Routines
458360efbdSAlfred PerlsteinSee
468360efbdSAlfred Perlstein.Xr rpc 3
478360efbdSAlfred Perlsteinfor the definition of the
488360efbdSAlfred Perlstein.Vt XDR
498360efbdSAlfred Perlsteindata structure.
508360efbdSAlfred Perlstein.Bl -tag -width XXXXX
518360efbdSAlfred Perlstein.It Fn xdr_accepted_reply
528360efbdSAlfred PerlsteinUsed to translate between RPC
538360efbdSAlfred Perlsteinreply messages and their external representation.
548360efbdSAlfred PerlsteinIt includes the status of the RPC
558360efbdSAlfred Perlsteincall in the XDR language format.
568360efbdSAlfred PerlsteinIn the case of success, it also includes the call results.
578360efbdSAlfred Perlstein.It Fn xdr_authsys_parms
588360efbdSAlfred PerlsteinUsed for describing
598360efbdSAlfred Perlstein.Ux
608360efbdSAlfred Perlsteinoperating system credentials.
618360efbdSAlfred PerlsteinIt includes machine-name, uid, gid list, etc.
628360efbdSAlfred Perlstein.It Fn xdr_callhdr
638360efbdSAlfred PerlsteinUsed for describing
648360efbdSAlfred PerlsteinRPC
658360efbdSAlfred Perlsteincall header messages.
668360efbdSAlfred PerlsteinIt encodes the static part of the call message header in the
678360efbdSAlfred PerlsteinXDR language format.
688360efbdSAlfred PerlsteinIt includes information such as transaction
698360efbdSAlfred PerlsteinID, RPC version number, program and version number.
708360efbdSAlfred Perlstein.It Fn xdr_callmsg
718360efbdSAlfred PerlsteinUsed for describing
728360efbdSAlfred PerlsteinRPC call messages.
738360efbdSAlfred PerlsteinThis includes all the RPC
748360efbdSAlfred Perlsteincall information such as transaction
758360efbdSAlfred PerlsteinID, RPC version number, program number, version number,
768360efbdSAlfred Perlsteinauthentication information, etc.
778360efbdSAlfred PerlsteinThis is normally used by servers to determine information about the client
788360efbdSAlfred PerlsteinRPC call.
798360efbdSAlfred Perlstein.It Fn xdr_opaque_auth
808360efbdSAlfred PerlsteinUsed for describing RPC
818360efbdSAlfred Perlsteinopaque authentication information messages.
828360efbdSAlfred Perlstein.It Fn xdr_rejected_reply
838360efbdSAlfred PerlsteinUsed for describing RPC reply messages.
848360efbdSAlfred PerlsteinIt encodes the rejected RPC message in the XDR language format.
858360efbdSAlfred PerlsteinThe message could be rejected either because of version
868360efbdSAlfred Perlsteinnumber mis-match or because of authentication errors.
878360efbdSAlfred Perlstein.It Fn xdr_replymsg
888360efbdSAlfred PerlsteinUsed for describing RPC
898360efbdSAlfred Perlsteinreply messages.
908360efbdSAlfred PerlsteinIt translates between the
918360efbdSAlfred PerlsteinRPC reply message and its external representation.
928360efbdSAlfred PerlsteinThis reply could be either an acceptance,
938360efbdSAlfred Perlsteinrejection or
948360efbdSAlfred Perlstein.Dv NULL .
958360efbdSAlfred Perlstein.El
968360efbdSAlfred Perlstein.Sh SEE ALSO
978360efbdSAlfred Perlstein.Xr rpc 3 ,
988360efbdSAlfred Perlstein.Xr xdr 3
99