xref: /netbsd-src/lib/libc/rpc/rpc_svc_err.3 (revision 472351e13db0de574eb46dc6a738ebfef119f0e3)
17df0ccbaSfvdl.\" @(#)rpc_svc_err.3n 1.23 93/08/31 SMI; from SVr4
27df0ccbaSfvdl.\" Copyright 1989 AT&T
37df0ccbaSfvdl.\" @(#)rpc_svc_err 1.4 89/06/28 SMI;
47df0ccbaSfvdl.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
5*472351e1Swiz.\"	$NetBSD: rpc_svc_err.3,v 1.6 2003/04/16 13:34:43 wiz Exp $
67df0ccbaSfvdl.Dd May 3, 1993
77df0ccbaSfvdl.Dt RPC_SVC_ERR 3
87df0ccbaSfvdl.Os
97df0ccbaSfvdl.Sh NAME
107df0ccbaSfvdl.Nm rpc_svc_err ,
117df0ccbaSfvdl.Nm svcerr_auth ,
127df0ccbaSfvdl.Nm svcerr_decode ,
137df0ccbaSfvdl.Nm svcerr_noproc ,
147df0ccbaSfvdl.Nm svcerr_noprog ,
157df0ccbaSfvdl.Nm svcerr_progvers ,
167df0ccbaSfvdl.Nm svcerr_systemerr ,
177df0ccbaSfvdl.Nm svcerr_weakauth
187df0ccbaSfvdl.Nd library routines for server side remote procedure call errors
197df0ccbaSfvdl.Sh LIBRARY
207df0ccbaSfvdl.Lb libc
217df0ccbaSfvdl.Sh SYNOPSIS
22*472351e1Swiz.In rpc/rpc.h
237df0ccbaSfvdl.Ft void
247df0ccbaSfvdl.Fn svcerr_auth "const SVCXPRT1 *xprt" "const enum auth_stat why"
257df0ccbaSfvdl.Ft void
267df0ccbaSfvdl.Fn svcerr_decode "const SVCXPRT *xprt"
277df0ccbaSfvdl.Ft void
287df0ccbaSfvdl.Fn svcerr_noproc "const SVCXPRT *xprt"
297df0ccbaSfvdl.Ft void
307df0ccbaSfvdl.Fn svcerr_noprog "const SVCXPRT *xprt"
317df0ccbaSfvdl.Ft void
327df0ccbaSfvdl.Fn svcerr_progvers "const SVCXPRT *xprt" "rpcvers_t low_vers" "rpcvers_t high_vers"
337df0ccbaSfvdl.Ft void
347df0ccbaSfvdl.Fn svcerr_systemerr "const SVCXPRT *xprt"
357df0ccbaSfvdl.Ft void
367df0ccbaSfvdl.Fn svcerr_weakauth "const SVCXPRT *xprt"
377df0ccbaSfvdl.Sh DESCRIPTION
387df0ccbaSfvdlThese routines are part of the RPC
397df0ccbaSfvdllibrary which allows C language programs to make procedure
407df0ccbaSfvdlcalls on other machines across the network.
417df0ccbaSfvdl.Pp
427df0ccbaSfvdlThese routines can be called by the server side
437df0ccbaSfvdldispatch function if there is any error in the
447df0ccbaSfvdltransaction with the client.
45723dbf64Swiz.Sh ROUTINES
467df0ccbaSfvdlSee
477df0ccbaSfvdl.Xr rpc 3
487df0ccbaSfvdlfor the definition of the
497df0ccbaSfvdl.Vt SVCXPRT
507df0ccbaSfvdldata structure.
517df0ccbaSfvdl.Pp
527df0ccbaSfvdl.Bl -tag -width XXXXX
537df0ccbaSfvdl.It Fn svcerr_auth
547df0ccbaSfvdlCalled by a service dispatch routine that refuses to perform
557df0ccbaSfvdla remote procedure call due to an authentication error.
567df0ccbaSfvdl.Pp
577df0ccbaSfvdl.Fn svcerr_decode
587df0ccbaSfvdlCalled by a service dispatch routine that cannot successfully
597df0ccbaSfvdldecode the remote parameters
607df0ccbaSfvdl(see
617df0ccbaSfvdl.Fn svc_getargs
627df0ccbaSfvdlin
637df0ccbaSfvdl.Xr rpc_svc_reg 3 ) .
647df0ccbaSfvdl.Pp
657df0ccbaSfvdl.It Fn svcerr_noproc
667df0ccbaSfvdlCalled by a service dispatch routine that does not implement
677df0ccbaSfvdlthe procedure number that the caller requests.
687df0ccbaSfvdl.Pp
697df0ccbaSfvdl.It Fn svcerr_noprog
707df0ccbaSfvdlCalled when the desired program is not registered with the
717df0ccbaSfvdlRPC package.
727df0ccbaSfvdlService implementors usually do not need this routine.
737df0ccbaSfvdl.Pp
747df0ccbaSfvdl.It Fn svcerr_progvers
757df0ccbaSfvdlCalled when the desired version of a program is not registered with the
767df0ccbaSfvdlRPC package.
777df0ccbaSfvdl.Fa low_vers
787df0ccbaSfvdlis the lowest version number,
797df0ccbaSfvdland
807df0ccbaSfvdl.Fa high_vers
817df0ccbaSfvdlis the highest version number.
827df0ccbaSfvdlService implementors usually do not need this routine.
837df0ccbaSfvdl.Pp
847df0ccbaSfvdl.It Fn svcerr_systemerr
857df0ccbaSfvdlCalled by a service dispatch routine when it detects a system
867df0ccbaSfvdlerror not covered by any particular protocol.
877df0ccbaSfvdlFor example, if a service can no longer allocate storage,
887df0ccbaSfvdlit may call this routine.
897df0ccbaSfvdl.Pp
907df0ccbaSfvdl.It Fn svcerr_weakauth
917df0ccbaSfvdlCalled by a service dispatch routine that refuses to perform
927df0ccbaSfvdla remote procedure call due to insufficient (but correct)
937df0ccbaSfvdlauthentication parameters.
947df0ccbaSfvdlThe routine calls
957df0ccbaSfvdl.Fn svcerr_auth "xprt" "AUTH_TOOWEAK" .
967df0ccbaSfvdl.El
977df0ccbaSfvdl.Sh SEE ALSO
987df0ccbaSfvdl.Xr rpc 3 ,
99723dbf64Swiz.Xr rpc_svc_calls 3 ,
1007df0ccbaSfvdl.Xr rpc_svc_create 3 ,
1017df0ccbaSfvdl.Xr rpc_svc_reg 3
102