te
 Copyright 2014 Nexenta Systems, Inc. All Rights Reserved.
 Copyright 1989 AT&T Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 RPC_SVC_ERR 3NSL "Nov 24, 2014"
 NAME
rpc_svc_err, svcerr_auth, svcerr_decode, svcerr_noproc, svcerr_noprog,
svcerr_progvers, svcerr_systemerr, svcerr_weakauth - library routines for
server side remote procedure call errors

 DESCRIPTION

These routines are part of the RPC library which allows C language
programs to make procedure calls on other machines across the network.


These routines can be called by the server side dispatch function if there is
any error in the transaction with the client.

 "Routines"

See rpc(3NSL) for the definition of the SVCXPRT data structure.

#include <rpc/rpc.h>



void svcerr_auth(const SVCXPRT *xprt, const enum auth_stat
why);


Called by a service dispatch routine that refuses to perform a remote procedure
call due to an authentication error.



void svcerr_decode(const SVCXPRT *xprt);


Called by a service dispatch routine that cannot successfully decode the remote
parameters (see svc_getargs() in rpc_svc_calls(3NSL)).



void svcerr_noproc(const SVCXPRT *xprt);


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



void svcerr_noprog(const SVCXPRT *xprt);


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



void svcerr_progvers(const SVCXPRT *xprt, const rpcvers_t
low_vers, const rpcvers_t high_vers);


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



void svcerr_systemerr(const SVCXPRT *xprt);


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.



void svcerr_weakauth(const SVCXPRT *xprt);


Called by a service dispatch routine that refuses to perform a remote procedure
call due to insufficient (but correct) authentication parameters. The routine
calls svcerr_auth(xprt, AUTH_TOOWEAK).




 ATTRIBUTES

See attributes(7) for descriptions of the following attributes:






ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe



 SEE ALSO

 rpc (3NSL),  rpc_svc_calls (3NSL),  rpc_svc_create (3NSL),  rpc_svc_reg (3NSL),  attributes (7)