[apple/libinfo.git] / rpc.subproj / clnt.h

/*
 * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
 * Reserved.  This file contains Original Code and/or Modifications of
 * Original Code as defined in and that are subject to the Apple Public
 * Source License Version 1.1 (the "License").  You may not use this file
 * except in compliance with the License.  Please obtain a copy of the
 * License at http://www.apple.com/publicsource and read it before using
 * this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * 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
 * OR ANY PART THEREOF.
 * 
 * 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.
 * 
 * Sun Microsystems, Inc.
 * 2550 Garcia Avenue
 * Mountain View, California  94043
 *
 *	from: @(#)clnt.h 1.31 88/02/08 SMI
 *	from: @(#)clnt.h	2.1 88/07/29 4.0 RPCSRC
 *	$Id: clnt.h,v 1.4 2004/10/28 21:58:22 emoy Exp $
 */

/*
 * clnt.h - Client side remote procedure call interface.
 *
 * Copyright (C) 1984, Sun Microsystems, Inc.
 */

#ifndef _RPC_CLNT_H_
#define _RPC_CLNT_H_
#include <sys/cdefs.h>

/*
 * 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.
 */

/* Avoid collision with mach definition */
#if defined(RPC_SUCCESS)
#undef RPC_SUCCESS
#endif

enum clnt_stat {
	RPC_SUCCESS=0,			/* call succeeded */
	/*
	 * local errors
	 */
	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 */
	/*
	 * remote errors
	 */
	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" */

	/*
	 * callrpc & clnt_create errors
	 */
	RPC_UNKNOWNHOST=13,		/* unknown host name */
	RPC_UNKNOWNPROTO=17,		/* unkown protocol */

	/*
	 * _ create errors
	 */
	RPC_PMAPFAILURE=14,		/* the pmapper failed in its call */
	RPC_PROGNOTREGISTERED=15,	/* remote program is not registered */
	/*
	 * unspecified error
	 */
	RPC_FAILED=16
};


/*
 * Error info.
 */
struct rpc_err {
	enum clnt_stat re_status;
	union {
		int RE_errno;		/* realated system error */
		enum auth_stat RE_why;	/* why the auth error occurred */
		struct {
			unsigned long low;	/* lowest verion supported */
			unsigned long high;	/* highest verion supported */
		} RE_vers;
		struct {		/* maybe meaningful if RPC_FAILED */
			long s1;
			long s2;
		} RE_lb;		/* life boot & debugging only */
	} ru;
#define	re_errno	ru.RE_errno
#define	re_why		ru.RE_why
#define	re_vers		ru.RE_vers
#define	re_lb		ru.RE_lb
};


/*
 * Client rpc handle.
 * Created by individual implementations, see e.g. rpc_udp.c.
 * Client is responsible for initializing auth, see e.g. auth_none.c.
 */
typedef struct CLIENT CLIENT;
struct CLIENT
{
	AUTH	*cl_auth;	/* authenticator */
	struct clnt_ops {
		enum clnt_stat (*cl_call)(CLIENT *, unsigned long, xdrproc_t, void *, xdrproc_t, void *, struct timeval); 	/* call remote procedure */
		void (*cl_abort)(void); 	/* abort a call */
		void (*cl_geterr)(CLIENT *, struct rpc_err *); 	/* get specific error code */
		bool_t (*cl_freeres)(CLIENT *, xdrproc_t, void *); 	/* frees results */
		void (*cl_destroy)(CLIENT *); 	/* destroy this structure */
		bool_t (*cl_control)(CLIENT *, int, char *); 	/* the ioctl() of rpc */
	} *cl_ops;
	caddr_t cl_private;	/* private stuff */
};

/*
 * client side rpc interface ops
 *
 * Parameter types are:
 *
 */

/*
 * enum clnt_stat
 * CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout)
 * 	CLIENT *rh;
 *	unsigned long proc;
 *	xdrproc_t xargs;
 *	caddr_t argsp;
 *	xdrproc_t xres;
 *	caddr_t resp;
 *	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))

/*
 * void
 * CLNT_ABORT(rh);
 * 	CLIENT *rh;
 */
#define	CLNT_ABORT(rh)	((*(rh)->cl_ops->cl_abort)(rh))
#define	clnt_abort(rh)	((*(rh)->cl_ops->cl_abort)(rh))

/*
 * struct rpc_err
 * CLNT_GETERR(rh);
 * 	CLIENT *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))


/*
 * bool_t
 * CLNT_FREERES(rh, xres, resp);
 * 	CLIENT *rh;
 *	xdrproc_t xres;
 *	caddr_t 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))

/*
 * bool_t
 * CLNT_CONTROL(cl, request, info)
 *      CLIENT *cl;
 *      unsigned int request;
 *      char *info;
 */
#define	CLNT_CONTROL(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in))
#define	clnt_control(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in))

/*
 * control operations that apply to both udp and tcp transports
 */
#define CLSET_TIMEOUT       1   /* set timeout (timeval) */
#define CLGET_TIMEOUT       2   /* get timeout (timeval) */
#define CLGET_SERVER_ADDR   3   /* get server's address (sockaddr) */
/*
 * udp only control operations
 */
#define CLSET_RETRY_TIMEOUT 4   /* set retry timeout (timeval) */
#define CLGET_RETRY_TIMEOUT 5   /* get retry timeout (timeval) */

/*
 * void
 * CLNT_DESTROY(rh);
 * 	CLIENT *rh;
 */
#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		((unsigned long)1)
#define RPCTEST_VERSION		((unsigned long)1)
#define RPCTEST_NULL_PROC	((unsigned long)2)
#define RPCTEST_NULL_BATCH_PROC	((unsigned long)3)

/*
 * By convention, procedure 0 takes null arguments and returns them
 */

#define NULLPROC ((unsigned 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)
 * CLIENT *
 * clntraw_create(prog, vers)
 *	unsigned long prog;
 *	unsigned long vers;
 */
__BEGIN_DECLS
extern CLIENT *clntraw_create	__P((unsigned long, unsigned long));
__END_DECLS


/*
 * Generic client creation routine. Supported protocols are "udp" and "tcp"
 * CLIENT *
 * clnt_create(host, prog, vers, prot);
 *	char *host; 	-- hostname
 *	unsigned long prog;	-- program number
 *	unsigned long vers;	-- version number
 *	char *prot;	-- protocol
 */
__BEGIN_DECLS
extern CLIENT *clnt_create	__P((char *, unsigned long, unsigned long, char *));
__END_DECLS


/*
 * TCP based rpc
 * CLIENT *
 * clnttcp_create(raddr, prog, vers, sockp, sendsz, recvsz)
 *	struct sockaddr_in *raddr;
 *	unsigned long prog;
 *	unsigned long version;
 *	register int *sockp;
 *	unsigned int sendsz;
 *	unsigned int recvsz;
 */
__BEGIN_DECLS
extern CLIENT *clnttcp_create	__P((struct sockaddr_in *,
				     unsigned long,
				     unsigned long,
				     int *,
				     unsigned int,
				     unsigned int));
__END_DECLS


/*
 * UDP based rpc.
 * CLIENT *
 * clntudp_create(raddr, program, version, wait, sockp)
 *	struct sockaddr_in *raddr;
 *	unsigned long program;
 *	unsigned long version;
 *	struct timeval wait;
 *	int *sockp;
 *
 * Same as above, but you specify max packet sizes.
 * CLIENT *
 * clntudp_bufcreate(raddr, program, version, wait, sockp, sendsz, recvsz)
 *	struct sockaddr_in *raddr;
 *	unsigned long program;
 *	unsigned long version;
 *	struct timeval wait;
 *	int *sockp;
 *	unsigned int sendsz;
 *	unsigned int recvsz;
 */
__BEGIN_DECLS
extern CLIENT *clntudp_create	__P((struct sockaddr_in *,
				     unsigned long,
				     unsigned long,
				     struct timeval,
				     int *));
extern CLIENT *clntudp_bufcreate __P((struct sockaddr_in *,
				     unsigned long,
				     unsigned long,
				     struct timeval,
				     int *,
				     unsigned int,
				     unsigned int));
__END_DECLS


/*
 * Print why creation failed
 */
__BEGIN_DECLS
extern void clnt_pcreateerror	__P((char *));			/* stderr */
extern char *clnt_spcreateerror	__P((char *));			/* string */
__END_DECLS

/*
 * Like clnt_perror(), but is more verbose in its output
 */ 
__BEGIN_DECLS
extern void clnt_perrno		__P((enum clnt_stat));		/* stderr */
extern char *clnt_sperrno	__P((enum clnt_stat));		/* string */
__END_DECLS

/*
 * Print an English error message, given the client error code
 */
__BEGIN_DECLS
extern void clnt_perror		__P((CLIENT *, char *)); 	/* stderr */
extern char *clnt_sperror	__P((CLIENT *, char *));	/* string */
__END_DECLS


/* 
 * If a creation fails, the following allows the user to figure out why.
 */
struct rpc_createerr {
	enum clnt_stat cf_stat;
	struct rpc_err cf_error; /* useful when cf_stat == RPC_PMAPFAILURE */
};

extern struct rpc_createerr rpc_createerr;


#define UDPMSGSIZE	8800	/* rpc imposed limit on udp msg size */
#define RPCSMALLMSGSIZE	400	/* a more reasonable packet size */

#endif /* !_RPC_CLNT_H */
Commit	Line	Data
03fb6eb0 A	1	/*
	2	* Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
ad21edcc A	6	* Portions Copyright (c) 1999 Apple Computer, Inc. All Rights
	7	* Reserved. This file contains Original Code and/or Modifications of
	8	* Original Code as defined in and that are subject to the Apple Public
	9	* Source License Version 1.1 (the "License"). You may not use this file
	10	* except in compliance with the License. Please obtain a copy of the
	11	* License at http://www.apple.com/publicsource and read it before using
	12	* this file.
03fb6eb0 A	13	*
03fb6eb0 A	14	* The Original Code and all software distributed under the License are
ad21edcc	15	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
03fb6eb0 A	16	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
03fb6eb0 A	17	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
ad21edcc A	18	* FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT. Please see the
	19	* License for the specific language governing rights and limitations
	20	* under the License.
03fb6eb0 A	21	*
	22	* @APPLE_LICENSE_HEADER_END@
	23	*/
	24	/*
	25	* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
	26	* unrestricted use provided that this legend is included on all tape
	27	* media and as a part of the software program in whole or part. Users
	28	* may copy or modify Sun RPC without charge, but are not authorized
	29	* to license or distribute it to anyone else except as part of a product or
	30	* program developed by the user.
	31	*
	32	* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
	33	* WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
	34	* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
	35	*
	36	* Sun RPC is provided with no support and without any obligation on the
	37	* part of Sun Microsystems, Inc. to assist in its use, correction,
	38	* modification or enhancement.
	39	*
	40	* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
	41	* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
	42	* OR ANY PART THEREOF.
	43	*
	44	* In no event will Sun Microsystems, Inc. be liable for any lost revenue
	45	* or profits or other special, indirect and consequential damages, even if
	46	* Sun has been advised of the possibility of such damages.
	47	*
	48	* Sun Microsystems, Inc.
	49	* 2550 Garcia Avenue
	50	* Mountain View, California 94043
	51	*
	52	* from: @(#)clnt.h 1.31 88/02/08 SMI
	53	* from: @(#)clnt.h 2.1 88/07/29 4.0 RPCSRC
c29f2fcc	54	* $Id: clnt.h,v 1.4 2004/10/28 21:58:22 emoy Exp $
03fb6eb0 A	55	*/
	56
	57	/*
	58	* clnt.h - Client side remote procedure call interface.
	59	*
	60	* Copyright (C) 1984, Sun Microsystems, Inc.
	61	*/
	62
	63	#ifndef _RPC_CLNT_H_
	64	#define _RPC_CLNT_H_
	65	#include <sys/cdefs.h>
	66
	67	/*
	68	* Rpc calls return an enum clnt_stat. This should be looked at more,
	69	* since each implementation is required to live with this (implementation
	70	* independent) list of errors.
	71	*/
	72
	73	/* Avoid collision with mach definition */
	74	#if defined(RPC_SUCCESS)
	75	#undef RPC_SUCCESS
	76	#endif
	77
	78	enum clnt_stat {
	79	RPC_SUCCESS=0, /* call succeeded */
	80	/*
	81	* local errors
	82	*/
	83	RPC_CANTENCODEARGS=1, /* can't encode arguments */
	84	RPC_CANTDECODERES=2, /* can't decode results */
	85	RPC_CANTSEND=3, /* failure in sending call */
	86	RPC_CANTRECV=4, /* failure in receiving result */
	87	RPC_TIMEDOUT=5, /* call timed out */
	88	/*
	89	* remote errors
	90	*/
	91	RPC_VERSMISMATCH=6, /* rpc versions not compatible */
	92	RPC_AUTHERROR=7, /* authentication error */
	93	RPC_PROGUNAVAIL=8, /* program not available */
	94	RPC_PROGVERSMISMATCH=9, /* program version mismatched */
	95	RPC_PROCUNAVAIL=10, /* procedure unavailable */
	96	RPC_CANTDECODEARGS=11, /* decode arguments error */
	97	RPC_SYSTEMERROR=12, /* generic "other problem" */
	98
	99	/*
	100	* callrpc & clnt_create errors
	101	*/
	102	RPC_UNKNOWNHOST=13, /* unknown host name */
	103	RPC_UNKNOWNPROTO=17, /* unkown protocol */
	104
	105	/*
	106	* _ create errors
	107	*/
	108	RPC_PMAPFAILURE=14, /* the pmapper failed in its call */
	109	RPC_PROGNOTREGISTERED=15, /* remote program is not registered */
	110	/*
	111	* unspecified error
	112	*/
	113	RPC_FAILED=16
	114	};
	115
	116
	117	/*
	118	* Error info.
119	*/
120	struct rpc_err {
121	enum clnt_stat re_status;
122	union {
123	int RE_errno; /* realated system error */
124	enum auth_stat RE_why; /* why the auth error occurred */
125	struct {
c29f2fcc A	126	unsigned long low; /* lowest verion supported */
c29f2fcc A	127	unsigned long high; /* highest verion supported */
03fb6eb0 A	128	} RE_vers;
	129	struct { /* maybe meaningful if RPC_FAILED */
	130	long s1;
	131	long s2;
	132	} RE_lb; /* life boot & debugging only */
	133	} ru;
	134	#define re_errno ru.RE_errno
	135	#define re_why ru.RE_why
	136	#define re_vers ru.RE_vers
	137	#define re_lb ru.RE_lb
	138	};
	139
	140
	141	/*
	142	* Client rpc handle.
	143	* Created by individual implementations, see e.g. rpc_udp.c.
	144	* Client is responsible for initializing auth, see e.g. auth_none.c.
	145	*/
ccd4a120 A	146	typedef struct CLIENT CLIENT;
	147	struct CLIENT
	148	{
	149	AUTH cl_auth; / authenticator */
03fb6eb0	150	struct clnt_ops {
c29f2fcc	151	enum clnt_stat (cl_call)(CLIENT , unsigned long, xdrproc_t, void , xdrproc_t, void , struct timeval); /* call remote procedure */
ccd4a120 A	152	void (cl_abort)(void); / abort a call */
	153	void (cl_geterr)(CLIENT , struct rpc_err ); / get specific error code */
	154	bool_t (cl_freeres)(CLIENT , xdrproc_t, void ); / frees results */
	155	void (cl_destroy)(CLIENT ); /* destroy this structure */
	156	bool_t (cl_control)(CLIENT , int, char ); / the ioctl() of rpc */
03fb6eb0	157	} *cl_ops;
ccd4a120 A	158	caddr_t cl_private; /* private stuff */
ccd4a120 A	159	};
03fb6eb0 A	160
	161	/*
	162	* client side rpc interface ops
	163	*
	164	* Parameter types are:
	165	*
	166	*/
	167
	168	/*
	169	* enum clnt_stat
	170	* CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout)
	171	* CLIENT *rh;
c29f2fcc	172	* unsigned long proc;
03fb6eb0 A	173	* xdrproc_t xargs;
	174	* caddr_t argsp;
	175	* xdrproc_t xres;
	176	* caddr_t resp;
	177	* struct timeval timeout;
	178	*/
	179	#define CLNT_CALL(rh, proc, xargs, argsp, xres, resp, secs) \
	180	((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))
	181	#define clnt_call(rh, proc, xargs, argsp, xres, resp, secs) \
	182	((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))
	183
	184	/*
	185	* void
	186	* CLNT_ABORT(rh);
	187	* CLIENT *rh;
	188	*/
	189	#define CLNT_ABORT(rh) ((*(rh)->cl_ops->cl_abort)(rh))
	190	#define clnt_abort(rh) ((*(rh)->cl_ops->cl_abort)(rh))
	191
	192	/*
	193	* struct rpc_err
	194	* CLNT_GETERR(rh);
	195	* CLIENT *rh;
	196	*/
	197	#define CLNT_GETERR(rh,errp) ((*(rh)->cl_ops->cl_geterr)(rh, errp))
	198	#define clnt_geterr(rh,errp) ((*(rh)->cl_ops->cl_geterr)(rh, errp))
	199
	200
	201	/*
	202	* bool_t
	203	* CLNT_FREERES(rh, xres, resp);
	204	* CLIENT *rh;
	205	* xdrproc_t xres;
	206	* caddr_t resp;
	207	*/
	208	#define CLNT_FREERES(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))
	209	#define clnt_freeres(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))
	210
	211	/*
	212	* bool_t
	213	* CLNT_CONTROL(cl, request, info)
	214	* CLIENT *cl;
c29f2fcc	215	* unsigned int request;
03fb6eb0 A	216	* char *info;
	217	*/
	218	#define CLNT_CONTROL(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in))
	219	#define clnt_control(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in))
	220
	221	/*
	222	* control operations that apply to both udp and tcp transports
	223	*/
	224	#define CLSET_TIMEOUT 1 /* set timeout (timeval) */
	225	#define CLGET_TIMEOUT 2 /* get timeout (timeval) */
	226	#define CLGET_SERVER_ADDR 3 /* get server's address (sockaddr) */
	227	/*
	228	* udp only control operations
	229	*/
	230	#define CLSET_RETRY_TIMEOUT 4 /* set retry timeout (timeval) */
	231	#define CLGET_RETRY_TIMEOUT 5 /* get retry timeout (timeval) */
	232
	233	/*
	234	* void
	235	* CLNT_DESTROY(rh);
	236	* CLIENT *rh;
	237	*/
	238	#define CLNT_DESTROY(rh) ((*(rh)->cl_ops->cl_destroy)(rh))
	239	#define clnt_destroy(rh) ((*(rh)->cl_ops->cl_destroy)(rh))
	240
	241
	242	/*
	243	* RPCTEST is a test program which is accessable on every rpc
	244	* transport/port. It is used for testing, performance evaluation,
	245	* and network administration.
	246	*/
	247
c29f2fcc A	248	#define RPCTEST_PROGRAM ((unsigned long)1)
	249	#define RPCTEST_VERSION ((unsigned long)1)
	250	#define RPCTEST_NULL_PROC ((unsigned long)2)
	251	#define RPCTEST_NULL_BATCH_PROC ((unsigned long)3)
03fb6eb0 A	252
	253	/*
	254	* By convention, procedure 0 takes null arguments and returns them
	255	*/
	256
c29f2fcc	257	#define NULLPROC ((unsigned long)0)
03fb6eb0 A	258
	259	/*
	260	* Below are the client handle creation routines for the various
	261	* implementations of client side rpc. They can return NULL if a
	262	* creation failure occurs.
	263	*/
	264
	265	/*
	266	* Memory based rpc (for speed check and testing)
	267	* CLIENT *
	268	* clntraw_create(prog, vers)
c29f2fcc A	269	* unsigned long prog;
c29f2fcc A	270	* unsigned long vers;
03fb6eb0 A	271	*/
03fb6eb0 A	272	__BEGIN_DECLS
c29f2fcc	273	extern CLIENT *clntraw_create __P((unsigned long, unsigned long));
03fb6eb0 A	274	__END_DECLS
	275
	276
	277	/*
	278	* Generic client creation routine. Supported protocols are "udp" and "tcp"
	279	* CLIENT *
	280	* clnt_create(host, prog, vers, prot);
	281	* char *host; -- hostname
c29f2fcc A	282	* unsigned long prog; -- program number
c29f2fcc A	283	* unsigned long vers; -- version number
03fb6eb0 A	284	* char *prot; -- protocol
	285	*/
	286	__BEGIN_DECLS
c29f2fcc	287	extern CLIENT clnt_create __P((char , unsigned long, unsigned long, char *));
03fb6eb0 A	288	__END_DECLS
	289
	290
	291	/*
	292	* TCP based rpc
	293	* CLIENT *
	294	* clnttcp_create(raddr, prog, vers, sockp, sendsz, recvsz)
	295	* struct sockaddr_in *raddr;
c29f2fcc A	296	* unsigned long prog;
c29f2fcc A	297	* unsigned long version;
03fb6eb0	298	* register int *sockp;
c29f2fcc A	299	* unsigned int sendsz;
c29f2fcc A	300	* unsigned int recvsz;
03fb6eb0 A	301	*/
	302	__BEGIN_DECLS
	303	extern CLIENT clnttcp_create __P((struct sockaddr_in ,
c29f2fcc A	304	unsigned long,
c29f2fcc A	305	unsigned long,
03fb6eb0	306	int *,
c29f2fcc A	307	unsigned int,
c29f2fcc A	308	unsigned int));
03fb6eb0 A	309	__END_DECLS
	310
	311
	312	/*
	313	* UDP based rpc.
	314	* CLIENT *
	315	* clntudp_create(raddr, program, version, wait, sockp)
	316	* struct sockaddr_in *raddr;
c29f2fcc A	317	* unsigned long program;
c29f2fcc A	318	* unsigned long version;
03fb6eb0 A	319	* struct timeval wait;
	320	* int *sockp;
	321	*
	322	* Same as above, but you specify max packet sizes.
	323	* CLIENT *
	324	* clntudp_bufcreate(raddr, program, version, wait, sockp, sendsz, recvsz)
	325	* struct sockaddr_in *raddr;
c29f2fcc A	326	* unsigned long program;
c29f2fcc A	327	* unsigned long version;
03fb6eb0 A	328	* struct timeval wait;
03fb6eb0 A	329	* int *sockp;
c29f2fcc A	330	* unsigned int sendsz;
c29f2fcc A	331	* unsigned int recvsz;
03fb6eb0 A	332	*/
	333	__BEGIN_DECLS
	334	extern CLIENT clntudp_create __P((struct sockaddr_in ,
c29f2fcc A	335	unsigned long,
c29f2fcc A	336	unsigned long,
03fb6eb0 A	337	struct timeval,
	338	int *));
	339	extern CLIENT clntudp_bufcreate __P((struct sockaddr_in ,
c29f2fcc A	340	unsigned long,
c29f2fcc A	341	unsigned long,
03fb6eb0 A	342	struct timeval,
03fb6eb0 A	343	int *,
c29f2fcc A	344	unsigned int,
c29f2fcc A	345	unsigned int));
03fb6eb0 A	346	__END_DECLS
	347
	348
	349	/*
	350	* Print why creation failed
	351	*/
	352	__BEGIN_DECLS
	353	extern void clnt_pcreateerror __P((char )); / stderr */
	354	extern char clnt_spcreateerror __P((char )); /* string */
	355	__END_DECLS
	356
	357	/*
	358	* Like clnt_perror(), but is more verbose in its output
	359	*/
	360	__BEGIN_DECLS
	361	extern void clnt_perrno __P((enum clnt_stat)); /* stderr */
	362	extern char clnt_sperrno __P((enum clnt_stat)); / string */
	363	__END_DECLS
	364
	365	/*
	366	* Print an English error message, given the client error code
	367	*/
	368	__BEGIN_DECLS
	369	extern void clnt_perror __P((CLIENT , char )); /* stderr */
	370	extern char clnt_sperror __P((CLIENT , char )); / string */
	371	__END_DECLS
	372
	373
	374	/*
	375	* If a creation fails, the following allows the user to figure out why.
	376	*/
	377	struct rpc_createerr {
	378	enum clnt_stat cf_stat;
	379	struct rpc_err cf_error; /* useful when cf_stat == RPC_PMAPFAILURE */
	380	};
	381
	382	extern struct rpc_createerr rpc_createerr;
	383
	384
	385	#define UDPMSGSIZE 8800 /* rpc imposed limit on udp msg size */
	386	#define RPCSMALLMSGSIZE 400 /* a more reasonable packet size */
	387
	388	#endif /* !_RPC_CLNT_H */