man/rpc_xdr.3t

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