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