Home | History | Annotate | Line # | Download | only in rpc 
 @(#)rpc_svc_err.3n 1.23 93/08/31 SMI; from SVr4
 Copyright 1989 AT&T
 @(#)rpc_svc_err 1.4 89/06/28 SMI;
 Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
 $NetBSD: rpc_svc_err.3,v 1.6 2003/04/16 13:34:43 wiz Exp $
.Dd May 3, 1993
.Dt RPC_SVC_ERR 3
.Os
.Sh NAME
.Nm rpc_svc_err ,
.Nm svcerr_auth ,
.Nm svcerr_decode ,
.Nm svcerr_noproc ,
.Nm svcerr_noprog ,
.Nm svcerr_progvers ,
.Nm svcerr_systemerr ,
.Nm svcerr_weakauth
.Nd library routines for server side remote procedure call errors
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
n rpc/rpc.h .Ft void
.Fn svcerr_auth "const SVCXPRT1 *xprt" "const enum auth_stat why"
.Ft void
.Fn svcerr_decode "const SVCXPRT *xprt"
.Ft void
.Fn svcerr_noproc "const SVCXPRT *xprt"
.Ft void
.Fn svcerr_noprog "const SVCXPRT *xprt"
.Ft void
.Fn svcerr_progvers "const SVCXPRT *xprt" "rpcvers_t low_vers" "rpcvers_t high_vers"
.Ft void
.Fn svcerr_systemerr "const SVCXPRT *xprt"
.Ft void
.Fn svcerr_weakauth "const SVCXPRT *xprt"
.Sh DESCRIPTION
These routines are part of the RPC
library which allows C language programs to make procedure
calls on other machines across the network.

p
These routines can be called by the server side
dispatch function if there is any error in the
transaction with the client.
.Sh ROUTINES
See
.Xr rpc 3
for the definition of the
.Vt SVCXPRT
data structure.

p
l -tag -width XXXXX t Fn svcerr_auth Called by a service dispatch routine that refuses to perform
a remote procedure call due to an authentication error.

p
.Fn svcerr_decode
Called by a service dispatch routine that cannot successfully
decode the remote parameters
(see
.Fn svc_getargs
in
.Xr rpc_svc_reg 3 ) .

p
t Fn svcerr_noproc Called by a service dispatch routine that does not implement
the procedure number that the caller requests.

p
t Fn svcerr_noprog Called when the desired program is not registered with the
RPC package.
Service implementors usually do not need this routine.

p
t Fn svcerr_progvers Called when the desired version of a program is not registered with the
RPC package.
.Fa low_vers
is the lowest version number,
and
.Fa high_vers
is the highest version number.
Service implementors usually do not need this routine.

p
t Fn svcerr_systemerr Called by a service dispatch routine when it detects a system
error not covered by any particular protocol.
For example, if a service can no longer allocate storage,
it may call this routine.

p
t Fn svcerr_weakauth Called by a service dispatch routine that refuses to perform
a remote procedure call due to insufficient (but correct)
authentication parameters.
The routine calls
.Fn svcerr_auth "xprt" "AUTH_TOOWEAK" .
.El
.Sh SEE ALSO
.Xr rpc 3 ,
.Xr rpc_svc_calls 3 ,
.Xr rpc_svc_create 3 ,
.Xr rpc_svc_reg 3