* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
* unrestricted use provided that this legend is included on all tape
* media and as a part of the software program in whole or part. Users
* may copy or modify Sun RPC without charge, but are not authorized
* to license or distribute it to anyone else except as part of a product or
* program developed by the user.
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
* WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
* Sun RPC is provided with no support and without any obligation on the
* part of Sun Microsystems, Inc. to assist in its use, correction,
* modification or enhancement.
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
* or profits or other special, indirect and consequential damages, even if
* Sun has been advised of the possibility of such damages.
* Mountain View, California 94043
/* @(#)clnt.h 1.3 85/03/20 SMI */
* clnt.h - Client side remote procedure call interface.
* Copyright (C) 1984, Sun Microsystems, Inc.
* Rpc calls return an enum clnt_stat. This should be looked at more,
* since each implementation is required to live with this (implementation
* independent) list of errors.
RPC_SUCCESS
=0, /* call succeeded */
RPC_CANTENCODEARGS
=1, /* can't encode arguments */
RPC_CANTDECODERES
=2, /* can't decode results */
RPC_CANTSEND
=3, /* failure in sending call */
RPC_CANTRECV
=4, /* failure in receiving result */
RPC_TIMEDOUT
=5, /* call timed out */
RPC_VERSMISMATCH
=6, /* rpc versions not compatible */
RPC_AUTHERROR
=7, /* authentication error */
RPC_PROGUNAVAIL
=8, /* program not available */
RPC_PROGVERSMISMATCH
=9, /* program version mismatched */
RPC_PROCUNAVAIL
=10, /* procedure unavailable */
RPC_CANTDECODEARGS
=11, /* decode arguments error */
RPC_SYSTEMERROR
=12, /* generic "other problem" */
RPC_UNKNOWNHOST
=13, /* unknown host name */
RPC_PMAPFAILURE
=14, /* the pmapper failed in its call */
RPC_PROGNOTREGISTERED
=15, /* remote program is not registered */
enum clnt_stat re_status
;
int RE_errno
; /* realated system error */
enum auth_stat RE_why
; /* why the auth error occurred */
u_long low
; /* lowest verion supported */
u_long high
; /* highest verion supported */
struct { /* maybe meaningful if RPC_FAILED */
} RE_lb
; /* life boot & debugging only */
#define re_errno ru.RE_errno
#define re_vers ru.RE_vers
* Created by individual implementations, see e.g. rpc_udp.c.
* Client is responsible for initializing auth, see e.g. auth_none.c.
AUTH
*cl_auth
; /* authenticator */
enum clnt_stat (*cl_call
)(); /* call remote procedure */
void (*cl_abort
)(); /* abort a call */
void (*cl_geterr
)(); /* get specific error code */
bool_t (*cl_freeres
)(); /* frees results */
void (*cl_destroy
)();/* destroy this structure */
caddr_t cl_private
; /* private stuff */
* client side rpc interface ops
* CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout)
* struct timeval timeout;
#define CLNT_CALL(rh, proc, xargs, argsp, xres, resp, secs) \
((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))
#define clnt_call(rh, proc, xargs, argsp, xres, resp, secs) \
((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))
#define CLNT_ABORT(rh) ((*(rh)->cl_ops->cl_abort)(rh))
#define clnt_abort(rh) ((*(rh)->cl_ops->cl_abort)(rh))
#define CLNT_GETERR(rh,errp) ((*(rh)->cl_ops->cl_geterr)(rh, errp))
#define clnt_geterr(rh,errp) ((*(rh)->cl_ops->cl_geterr)(rh, errp))
* CLNT_FREERES(rh, xres, resp);
#define CLNT_FREERES(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))
#define clnt_freeres(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))
#define CLNT_DESTROY(rh) ((*(rh)->cl_ops->cl_destroy)(rh))
#define clnt_destroy(rh) ((*(rh)->cl_ops->cl_destroy)(rh))
* RPCTEST is a test program which is accessable on every rpc
* transport/port. It is used for testing, performance evaluation,
* and network administration.
#define RPCTEST_PROGRAM ((u_long)1)
#define RPCTEST_VERSION ((u_long)1)
#define RPCTEST_NULL_PROC ((u_long)2)
#define RPCTEST_NULL_BATCH_PROC ((u_long)3)
* By convention, procedure 0 takes null arguments and returns them
#define NULLPROC ((u_long)0)
* Below are the client handle creation routines for the various
* implementations of client side rpc. They can return NULL if a
* creation failure occurs.
* Memory based rpc (for speed check and testing)
* clntraw_create(prog, vers)
extern CLIENT
*clntraw_create();
* clntudp_create(raddr, program, version, wait, sockp)
* struct sockaddr_in *raddr;
extern CLIENT
*clntudp_create();
* clnttcp_create(raddr, prog, vers, sockp, sendsz, recvsz)
* struct sockaddr_in *raddr;
extern CLIENT
*clnttcp_create();
* If a creation fails, the following allows the user to figure out why.
struct rpc_err cf_error
; /* useful when cf_stat == RPC_PMAPFAILURE */
extern struct rpc_createerr rpc_createerr
;