lib/libc/rpc/rpc_xdr.3

   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 .\" $NetBSD: rpc_xdr.3,v 1.8 2009/04/11 16:03:29 joerg 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" "const struct accepted_reply *ar"
  24 .Ft bool_t
  25 .Fn xdr_authsys_parms "XDR *xdrs" "struct authsys_parms *aupp"
  26 .Ft void
  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" "const struct rejected_reply *rr"
  34 .Ft bool_t
  35 .Fn xdr_replymsg "XDR *xdrs" "const struct rpc_msg *rmsg"
  36 .Sh DESCRIPTION
  37 These routines are used for describing the
  38 RPC messages in XDR language.
  39 They should normally be used by those who do not
  40 want to use the RPC
  41 package directly.
  42 These routines return TRUE if they succeed, FALSE otherwise.
  43 .Sh ROUTINES
  44 See
  45 .Xr rpc 3
  46 for the definition of the
  47 .Vt XDR
  48 data structure.
  49 .Pp
  50 .Bl -tag -width XXXXX
  51 .It Fn xdr_accepted_reply
  52 Used to translate between RPC
  53 reply messages and their external representation.
  54 It includes the status of the RPC
  55 call in the XDR language format.
  56 In the case of success, it also includes the call results.
  57 .Pp
  58 .It Fn xdr_authsys_parms
  59 Used for describing UNIX operating system credentials.
  60 It includes machine-name, uid, gid list, etc.
  61 .Pp
  62 .It Fn xdr_callhdr
  63 Used for describing RPC call header messages.
  64 It encodes the static part of the call message header in the
  65 XDR language format.
  66 It includes information such as transaction
  67 ID, RPC version number, program and version number.
  68 .Pp
  69 .It Fn xdr_callmsg
  70 Used for describing
  71 RPC call messages.
  72 This includes all the  RPC
  73 call information such as transaction
  74 ID, RPC version number, program number, version number,
  75 authentication information, etc.
  76 This is normally used by servers to determine information about the client
  77 RPC call.
  78 .Pp
  79 .It Fn xdr_opaque_auth
  80 Used for describing RPC
  81 opaque authentication information messages.
  82 .Pp
  83 .It Fn xdr_rejected_reply
  84 Used for describing RPC reply messages.
  85 It encodes the rejected RPC message in the XDR language format.
  86 The message could be rejected either because of version
  87 number mis-match or because of authentication errors.
  88 .Pp
  89 .It Fn xdr_replymsg
  90 Used for describing RPC
  91 reply messages.
  92 It translates between the
  93 RPC reply message and its external representation.
  94 This reply could be either an acceptance,
  95 rejection or
  96 .Dv NULL .
  97 .El
  98 .Sh SEE ALSO
  99 .Xr rpc 3 ,
 100 .Xr xdr 3