lib/libc/rpc/rpc_svc_err.3

   1 .\" @(#)rpc_svc_err.3n 1.23 93/08/31 SMI; from SVr4
   2 .\" Copyright 1989 AT&T
   3 .\" @(#)rpc_svc_err 1.4 89/06/28 SMI;
   4 .\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
   5 .\"     $NetBSD: rpc_svc_err.3,v 1.6 2003/04/16 13:34:43 wiz Exp $
   6 .Dd May 3, 1993
   7 .Dt RPC_SVC_ERR 3
   8 .Os
   9 .Sh NAME
  10 .Nm rpc_svc_err ,
  11 .Nm svcerr_auth ,
  12 .Nm svcerr_decode ,
  13 .Nm svcerr_noproc ,
  14 .Nm svcerr_noprog ,
  15 .Nm svcerr_progvers ,
  16 .Nm svcerr_systemerr ,
  17 .Nm svcerr_weakauth
  18 .Nd library routines for server side remote procedure call errors
  19 .Sh LIBRARY
  20 .Lb libc
  21 .Sh SYNOPSIS
  22 .In rpc/rpc.h
  23 .Ft void
  24 .Fn svcerr_auth "const SVCXPRT1 *xprt" "const enum auth_stat why"
  25 .Ft void
  26 .Fn svcerr_decode "const SVCXPRT *xprt"
  27 .Ft void
  28 .Fn svcerr_noproc "const SVCXPRT *xprt"
  29 .Ft void
  30 .Fn svcerr_noprog "const SVCXPRT *xprt"
  31 .Ft void
  32 .Fn svcerr_progvers "const SVCXPRT *xprt" "rpcvers_t low_vers" "rpcvers_t high_vers"
  33 .Ft void
  34 .Fn svcerr_systemerr "const SVCXPRT *xprt"
  35 .Ft void
  36 .Fn svcerr_weakauth "const SVCXPRT *xprt"
  37 .Sh DESCRIPTION
  38 These routines are part of the RPC
  39 library which allows C language programs to make procedure
  40 calls on other machines across the network.
  41 .Pp
  42 These routines can be called by the server side
  43 dispatch function if there is any error in the
  44 transaction with the client.
  45 .Sh ROUTINES
  46 See
  47 .Xr rpc 3
  48 for the definition of the
  49 .Vt SVCXPRT
  50 data structure.
  51 .Pp
  52 .Bl -tag -width XXXXX
  53 .It Fn svcerr_auth
  54 Called by a service dispatch routine that refuses to perform
  55 a remote procedure call due to an authentication error.
  56 .Pp
  57 .Fn svcerr_decode
  58 Called by a service dispatch routine that cannot successfully
  59 decode the remote parameters
  60 (see
  61 .Fn svc_getargs
  62 in
  63 .Xr rpc_svc_reg 3 ) .
  64 .Pp
  65 .It Fn svcerr_noproc
  66 Called by a service dispatch routine that does not implement
  67 the procedure number that the caller requests.
  68 .Pp
  69 .It Fn svcerr_noprog
  70 Called when the desired program is not registered with the
  71 RPC package.
  72 Service implementors usually do not need this routine.
  73 .Pp
  74 .It Fn svcerr_progvers
  75 Called when the desired version of a program is not registered with the
  76 RPC package.
  77 .Fa low_vers
  78 is the lowest version number,
  79 and
  80 .Fa high_vers
  81 is the highest version number.
  82 Service implementors usually do not need this routine.
  83 .Pp
  84 .It Fn svcerr_systemerr
  85 Called by a service dispatch routine when it detects a system
  86 error not covered by any particular protocol.
  87 For example, if a service can no longer allocate storage,
  88 it may call this routine.
  89 .Pp
  90 .It Fn svcerr_weakauth
  91 Called by a service dispatch routine that refuses to perform
  92 a remote procedure call due to insufficient (but correct)
  93 authentication parameters.
  94 The routine calls
  95 .Fn svcerr_auth "xprt" "AUTH_TOOWEAK" .
  96 .El
  97 .Sh SEE ALSO
  98 .Xr rpc 3 ,
  99 .Xr rpc_svc_calls 3 ,
 100 .Xr rpc_svc_create 3 ,
 101 .Xr rpc_svc_reg 3