man/rpc_svc_err.3t

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