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