xref: /freebsd/lib/libc/rpc/rpc_svc_err.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
18360efbdSAlfred Perlstein.\" Copyright 1989 AT&T
28360efbdSAlfred Perlstein.\" Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.
38360efbdSAlfred Perlstein.\"	$NetBSD: rpc_svc_err.3,v 1.1 2000/06/02 23:11:14 fvdl Exp $
48360efbdSAlfred Perlstein.Dd May 3, 1993
58360efbdSAlfred Perlstein.Dt RPC_SVC_ERR 3
68360efbdSAlfred Perlstein.Os
78360efbdSAlfred Perlstein.Sh NAME
88360efbdSAlfred Perlstein.Nm rpc_svc_err ,
98360efbdSAlfred Perlstein.Nm svcerr_auth ,
108360efbdSAlfred Perlstein.Nm svcerr_decode ,
118360efbdSAlfred Perlstein.Nm svcerr_noproc ,
128360efbdSAlfred Perlstein.Nm svcerr_noprog ,
138360efbdSAlfred Perlstein.Nm svcerr_progvers ,
148360efbdSAlfred Perlstein.Nm svcerr_systemerr ,
158360efbdSAlfred Perlstein.Nm svcerr_weakauth
168360efbdSAlfred Perlstein.Nd library routines for server side remote procedure call errors
178360efbdSAlfred Perlstein.Sh LIBRARY
188360efbdSAlfred Perlstein.Lb libc
198360efbdSAlfred Perlstein.Sh SYNOPSIS
2032eef9aeSRuslan Ermilov.In rpc/rpc.h
218360efbdSAlfred Perlstein.Ft void
22db7534cfSBruce Evans.Fn svcerr_auth "SVCXPRT *xprt" "enum auth_stat why"
238360efbdSAlfred Perlstein.Ft void
24db7534cfSBruce Evans.Fn svcerr_decode "SVCXPRT *xprt"
258360efbdSAlfred Perlstein.Ft void
26db7534cfSBruce Evans.Fn svcerr_noproc "SVCXPRT *xprt"
278360efbdSAlfred Perlstein.Ft void
28db7534cfSBruce Evans.Fn svcerr_noprog "SVCXPRT *xprt"
298360efbdSAlfred Perlstein.Ft void
30db7534cfSBruce Evans.Fn svcerr_progvers "SVCXPRT *xprt" "rpcvers_t low_vers" "rpcvers_t high_vers"
318360efbdSAlfred Perlstein.Ft void
32db7534cfSBruce Evans.Fn svcerr_systemerr "SVCXPRT *xprt"
338360efbdSAlfred Perlstein.Ft void
34db7534cfSBruce Evans.Fn svcerr_weakauth "SVCXPRT *xprt"
358360efbdSAlfred Perlstein.Sh DESCRIPTION
368360efbdSAlfred PerlsteinThese routines are part of the RPC
378360efbdSAlfred Perlsteinlibrary which allows C language programs to make procedure
388360efbdSAlfred Perlsteincalls on other machines across the network.
398360efbdSAlfred Perlstein.Pp
408360efbdSAlfred PerlsteinThese routines can be called by the server side
418360efbdSAlfred Perlsteindispatch function if there is any error in the
428360efbdSAlfred Perlsteintransaction with the client.
438360efbdSAlfred Perlstein.Sh Routines
448360efbdSAlfred PerlsteinSee
458360efbdSAlfred Perlstein.Xr rpc 3
468360efbdSAlfred Perlsteinfor the definition of the
478360efbdSAlfred Perlstein.Vt SVCXPRT
488360efbdSAlfred Perlsteindata structure.
498360efbdSAlfred Perlstein.Bl -tag -width XXXXX
508360efbdSAlfred Perlstein.It Fn svcerr_auth
518360efbdSAlfred PerlsteinCalled by a service dispatch routine that refuses to perform
528360efbdSAlfred Perlsteina remote procedure call due to an authentication error.
538360efbdSAlfred Perlstein.It Fn svcerr_decode
548360efbdSAlfred PerlsteinCalled by a service dispatch routine that cannot successfully
552efeeba5SRuslan Ermilovdecode the remote arguments
568360efbdSAlfred Perlstein(see
578360efbdSAlfred Perlstein.Fn svc_getargs
588360efbdSAlfred Perlsteinin
598360efbdSAlfred Perlstein.Xr rpc_svc_reg 3 ) .
608360efbdSAlfred Perlstein.It Fn svcerr_noproc
618360efbdSAlfred PerlsteinCalled by a service dispatch routine that does not implement
628360efbdSAlfred Perlsteinthe procedure number that the caller requests.
638360efbdSAlfred Perlstein.It Fn svcerr_noprog
648360efbdSAlfred PerlsteinCalled when the desired program is not registered with the
658360efbdSAlfred PerlsteinRPC package.
668360efbdSAlfred PerlsteinService implementors usually do not need this routine.
678360efbdSAlfred Perlstein.It Fn svcerr_progvers
688360efbdSAlfred PerlsteinCalled when the desired version of a program is not registered with the
698360efbdSAlfred PerlsteinRPC package.
702efeeba5SRuslan ErmilovThe
718360efbdSAlfred Perlstein.Fa low_vers
722efeeba5SRuslan Ermilovargument
738360efbdSAlfred Perlsteinis the lowest version number,
748360efbdSAlfred Perlsteinand
758360efbdSAlfred Perlstein.Fa high_vers
768360efbdSAlfred Perlsteinis the highest version number.
778360efbdSAlfred PerlsteinService implementors usually do not need this routine.
788360efbdSAlfred Perlstein.It Fn svcerr_systemerr
798360efbdSAlfred PerlsteinCalled by a service dispatch routine when it detects a system
808360efbdSAlfred Perlsteinerror not covered by any particular protocol.
818360efbdSAlfred PerlsteinFor example, if a service can no longer allocate storage,
828360efbdSAlfred Perlsteinit may call this routine.
838360efbdSAlfred Perlstein.It Fn svcerr_weakauth
848360efbdSAlfred PerlsteinCalled by a service dispatch routine that refuses to perform
858360efbdSAlfred Perlsteina remote procedure call due to insufficient (but correct)
862efeeba5SRuslan Ermilovauthentication arguments.
878360efbdSAlfred PerlsteinThe routine calls
888360efbdSAlfred Perlstein.Fn svcerr_auth "xprt" "AUTH_TOOWEAK" .
898360efbdSAlfred Perlstein.El
908360efbdSAlfred Perlstein.Sh SEE ALSO
918360efbdSAlfred Perlstein.Xr rpc 3 ,
928360efbdSAlfred Perlstein.Xr rpc_svc_calls 3 ,
938360efbdSAlfred Perlstein.Xr rpc_svc_create 3 ,
948360efbdSAlfred Perlstein.Xr rpc_svc_reg 3
95