/* $NetBSD: clnt.h,v 1.14 2000/06/02 22:57:55 fvdl Exp $ */
|
/* $NetBSD: clnt.h,v 1.14 2000/06/02 22:57:55 fvdl Exp $ */
|
|
|
/*
|
/*
|
* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
|
* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
|
* unrestricted use provided that this legend is included on all tape
|
* 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
|
* 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
|
* 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
|
* to license or distribute it to anyone else except as part of a product or
|
* program developed by the user.
|
* program developed by the user.
|
*
|
*
|
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
|
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
|
* WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
* WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
|
* 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
|
* Sun RPC is provided with no support and without any obligation on the
|
* part of Sun Microsystems, Inc. to assist in its use, correction,
|
* part of Sun Microsystems, Inc. to assist in its use, correction,
|
* modification or enhancement.
|
* modification or enhancement.
|
*
|
*
|
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
|
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
|
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
|
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
|
* OR ANY PART THEREOF.
|
* OR ANY PART THEREOF.
|
*
|
*
|
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
|
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
|
* or profits or other special, indirect and consequential damages, even if
|
* or profits or other special, indirect and consequential damages, even if
|
* Sun has been advised of the possibility of such damages.
|
* Sun has been advised of the possibility of such damages.
|
*
|
*
|
* Sun Microsystems, Inc.
|
* Sun Microsystems, Inc.
|
* 2550 Garcia Avenue
|
* 2550 Garcia Avenue
|
* Mountain View, California 94043
|
* Mountain View, California 94043
|
*
|
*
|
* from: @(#)clnt.h 1.31 94/04/29 SMI
|
* from: @(#)clnt.h 1.31 94/04/29 SMI
|
* from: @(#)clnt.h 2.1 88/07/29 4.0 RPCSRC
|
* from: @(#)clnt.h 2.1 88/07/29 4.0 RPCSRC
|
* $FreeBSD: src/include/rpc/clnt.h,v 1.17 2002/04/28 15:18:45 des Exp $
|
* $FreeBSD: src/include/rpc/clnt.h,v 1.17 2002/04/28 15:18:45 des Exp $
|
*/
|
*/
|
|
|
/*
|
/*
|
* clnt.h - Client side remote procedure call interface.
|
* clnt.h - Client side remote procedure call interface.
|
*
|
*
|
* Copyright (C) 1984, Sun Microsystems, Inc.
|
* Copyright (C) 1984, Sun Microsystems, Inc.
|
*/
|
*/
|
|
|
#ifndef _RPC_CLNT_H_
|
#ifndef _RPC_CLNT_H_
|
#define _RPC_CLNT_H_
|
#define _RPC_CLNT_H_
|
#include <rpc/clnt_stat.h>
|
#include <rpc/clnt_stat.h>
|
#include <sys/cdefs.h>
|
#include <sys/cdefs.h>
|
#include <netconfig.h>
|
#include <netconfig.h>
|
#include <sys/un.h>
|
#include <sys/un.h>
|
|
|
/*
|
/*
|
* Well-known IPV6 RPC broadcast address.
|
* Well-known IPV6 RPC broadcast address.
|
*/
|
*/
|
#define RPCB_MULTICAST_ADDR "ff02::202"
|
#define RPCB_MULTICAST_ADDR "ff02::202"
|
|
|
/*
|
/*
|
* the following errors are in general unrecoverable. The caller
|
* the following errors are in general unrecoverable. The caller
|
* should give up rather than retry.
|
* should give up rather than retry.
|
*/
|
*/
|
#define IS_UNRECOVERABLE_RPC(s) (((s) == RPC_AUTHERROR) || \
|
#define IS_UNRECOVERABLE_RPC(s) (((s) == RPC_AUTHERROR) || \
|
((s) == RPC_CANTENCODEARGS) || \
|
((s) == RPC_CANTENCODEARGS) || \
|
((s) == RPC_CANTDECODERES) || \
|
((s) == RPC_CANTDECODERES) || \
|
((s) == RPC_VERSMISMATCH) || \
|
((s) == RPC_VERSMISMATCH) || \
|
((s) == RPC_PROCUNAVAIL) || \
|
((s) == RPC_PROCUNAVAIL) || \
|
((s) == RPC_PROGUNAVAIL) || \
|
((s) == RPC_PROGUNAVAIL) || \
|
((s) == RPC_PROGVERSMISMATCH) || \
|
((s) == RPC_PROGVERSMISMATCH) || \
|
((s) == RPC_CANTDECODEARGS))
|
((s) == RPC_CANTDECODEARGS))
|
|
|
/*
|
/*
|
* Error info.
|
* Error info.
|
*/
|
*/
|
struct rpc_err {
|
struct rpc_err {
|
enum clnt_stat re_status;
|
enum clnt_stat re_status;
|
union {
|
union {
|
int RE_errno; /* related system error */
|
int RE_errno; /* related system error */
|
enum auth_stat RE_why; /* why the auth error occurred */
|
enum auth_stat RE_why; /* why the auth error occurred */
|
struct {
|
struct {
|
rpcvers_t low; /* lowest version supported */
|
rpcvers_t low; /* lowest version supported */
|
rpcvers_t high; /* highest version supported */
|
rpcvers_t high; /* highest version supported */
|
} RE_vers;
|
} RE_vers;
|
struct { /* maybe meaningful if RPC_FAILED */
|
struct { /* maybe meaningful if RPC_FAILED */
|
int32_t s1;
|
int32_t s1;
|
int32_t s2;
|
int32_t s2;
|
} RE_lb; /* life boot & debugging only */
|
} RE_lb; /* life boot & debugging only */
|
} ru;
|
} ru;
|
#define re_errno ru.RE_errno
|
#define re_errno ru.RE_errno
|
#define re_why ru.RE_why
|
#define re_why ru.RE_why
|
#define re_vers ru.RE_vers
|
#define re_vers ru.RE_vers
|
#define re_lb ru.RE_lb
|
#define re_lb ru.RE_lb
|
};
|
};
|
|
|
|
|
/*
|
/*
|
* Client rpc handle.
|
* Client rpc handle.
|
* Created by individual implementations
|
* Created by individual implementations
|
* Client is responsible for initializing auth, see e.g. auth_none.c.
|
* Client is responsible for initializing auth, see e.g. auth_none.c.
|
*/
|
*/
|
typedef struct __rpc_client {
|
typedef struct __rpc_client {
|
AUTH *cl_auth; /* authenticator */
|
AUTH *cl_auth; /* authenticator */
|
struct clnt_ops {
|
struct clnt_ops {
|
/* call remote procedure */
|
/* call remote procedure */
|
enum clnt_stat (*cl_call)(struct __rpc_client *,
|
enum clnt_stat (*cl_call)(struct __rpc_client *,
|
rpcproc_t, xdrproc_t, void *, xdrproc_t,
|
rpcproc_t, xdrproc_t, void *, xdrproc_t,
|
void *, struct timeval);
|
void *, struct timeval);
|
/* abort a call */
|
/* abort a call */
|
void (*cl_abort)(struct __rpc_client *);
|
void (*cl_abort)(struct __rpc_client *);
|
/* get specific error code */
|
/* get specific error code */
|
void (*cl_geterr)(struct __rpc_client *,
|
void (*cl_geterr)(struct __rpc_client *,
|
struct rpc_err *);
|
struct rpc_err *);
|
/* frees results */
|
/* frees results */
|
bool_t (*cl_freeres)(struct __rpc_client *,
|
bool_t (*cl_freeres)(struct __rpc_client *,
|
xdrproc_t, void *);
|
xdrproc_t, void *);
|
/* destroy this structure */
|
/* destroy this structure */
|
void (*cl_destroy)(struct __rpc_client *);
|
void (*cl_destroy)(struct __rpc_client *);
|
/* the ioctl() of rpc */
|
/* the ioctl() of rpc */
|
bool_t (*cl_control)(struct __rpc_client *, u_int,
|
bool_t (*cl_control)(struct __rpc_client *, u_int,
|
void *);
|
void *);
|
} *cl_ops;
|
} *cl_ops;
|
void *cl_private; /* private stuff */
|
void *cl_private; /* private stuff */
|
char *cl_netid; /* network token */
|
char *cl_netid; /* network token */
|
char *cl_tp; /* device name */
|
char *cl_tp; /* device name */
|
} CLIENT;
|
} CLIENT;
|
|
|
|
|
/*
|
/*
|
* Timers used for the pseudo-transport protocol when using datagrams
|
* Timers used for the pseudo-transport protocol when using datagrams
|
*/
|
*/
|
struct rpc_timers {
|
struct rpc_timers {
|
u_short rt_srtt; /* smoothed round-trip time */
|
u_short rt_srtt; /* smoothed round-trip time */
|
u_short rt_deviate; /* estimated deviation */
|
u_short rt_deviate; /* estimated deviation */
|
u_long rt_rtxcur; /* current (backed-off) rto */
|
u_long rt_rtxcur; /* current (backed-off) rto */
|
};
|
};
|
|
|
/*
|
/*
|
* Feedback values used for possible congestion and rate control
|
* Feedback values used for possible congestion and rate control
|
*/
|
*/
|
#define FEEDBACK_REXMIT1 1 /* first retransmit */
|
#define FEEDBACK_REXMIT1 1 /* first retransmit */
|
#define FEEDBACK_OK 2 /* no retransmits */
|
#define FEEDBACK_OK 2 /* no retransmits */
|
|
|
/* Used to set version of portmapper used in broadcast */
|
/* Used to set version of portmapper used in broadcast */
|
|
|
#define CLCR_SET_LOWVERS 3
|
#define CLCR_SET_LOWVERS 3
|
#define CLCR_GET_LOWVERS 4
|
#define CLCR_GET_LOWVERS 4
|
|
|
#define RPCSMALLMSGSIZE 400 /* a more reasonable packet size */
|
#define RPCSMALLMSGSIZE 400 /* a more reasonable packet size */
|
|
|
/*
|
/*
|
* client side rpc interface ops
|
* client side rpc interface ops
|
*
|
*
|
* Parameter types are:
|
* Parameter types are:
|
*
|
*
|
*/
|
*/
|
|
|
/*
|
/*
|
* enum clnt_stat
|
* enum clnt_stat
|
* CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout)
|
* CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout)
|
* CLIENT *rh;
|
* CLIENT *rh;
|
* rpcproc_t proc;
|
* rpcproc_t proc;
|
* xdrproc_t xargs;
|
* xdrproc_t xargs;
|
* void *argsp;
|
* void *argsp;
|
* xdrproc_t xres;
|
* xdrproc_t xres;
|
* void *resp;
|
* void *resp;
|
* struct timeval timeout;
|
* struct timeval timeout;
|
*/
|
*/
|
#define CLNT_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, \
|
((*(rh)->cl_ops->cl_call)(rh, proc, xargs, \
|
argsp, xres, resp, secs))
|
argsp, xres, resp, secs))
|
#define clnt_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, \
|
((*(rh)->cl_ops->cl_call)(rh, proc, xargs, \
|
argsp, xres, resp, secs))
|
argsp, xres, resp, secs))
|
|
|
/*
|
/*
|
* void
|
* void
|
* CLNT_ABORT(rh);
|
* CLNT_ABORT(rh);
|
* CLIENT *rh;
|
* CLIENT *rh;
|
*/
|
*/
|
#define CLNT_ABORT(rh) ((*(rh)->cl_ops->cl_abort)(rh))
|
#define CLNT_ABORT(rh) ((*(rh)->cl_ops->cl_abort)(rh))
|
#define clnt_abort(rh) ((*(rh)->cl_ops->cl_abort)(rh))
|
#define clnt_abort(rh) ((*(rh)->cl_ops->cl_abort)(rh))
|
|
|
/*
|
/*
|
* struct rpc_err
|
* struct rpc_err
|
* CLNT_GETERR(rh);
|
* CLNT_GETERR(rh);
|
* CLIENT *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))
|
#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
|
* bool_t
|
* CLNT_FREERES(rh, xres, resp);
|
* CLNT_FREERES(rh, xres, resp);
|
* CLIENT *rh;
|
* CLIENT *rh;
|
* xdrproc_t xres;
|
* xdrproc_t xres;
|
* void *resp;
|
* void *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_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
|
* bool_t
|
* CLNT_CONTROL(cl, request, info)
|
* CLNT_CONTROL(cl, request, info)
|
* CLIENT *cl;
|
* CLIENT *cl;
|
* u_int request;
|
* u_int request;
|
* char *info;
|
* 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))
|
#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
|
* control operations that apply to both udp and tcp transports
|
*/
|
*/
|
#define CLSET_TIMEOUT 1 /* set timeout (timeval) */
|
#define CLSET_TIMEOUT 1 /* set timeout (timeval) */
|
#define CLGET_TIMEOUT 2 /* get timeout (timeval) */
|
#define CLGET_TIMEOUT 2 /* get timeout (timeval) */
|
#define CLGET_SERVER_ADDR 3 /* get server's address (sockaddr) */
|
#define CLGET_SERVER_ADDR 3 /* get server's address (sockaddr) */
|
#define CLGET_FD 6 /* get connections file descriptor */
|
#define CLGET_FD 6 /* get connections file descriptor */
|
#define CLGET_SVC_ADDR 7 /* get server's address (netbuf) */
|
#define CLGET_SVC_ADDR 7 /* get server's address (netbuf) */
|
#define CLSET_FD_CLOSE 8 /* close fd while clnt_destroy */
|
#define CLSET_FD_CLOSE 8 /* close fd while clnt_destroy */
|
#define CLSET_FD_NCLOSE 9 /* Do not close fd while clnt_destroy */
|
#define CLSET_FD_NCLOSE 9 /* Do not close fd while clnt_destroy */
|
#define CLGET_XID 10 /* Get xid */
|
#define CLGET_XID 10 /* Get xid */
|
#define CLSET_XID 11 /* Set xid */
|
#define CLSET_XID 11 /* Set xid */
|
#define CLGET_VERS 12 /* Get version number */
|
#define CLGET_VERS 12 /* Get version number */
|
#define CLSET_VERS 13 /* Set version number */
|
#define CLSET_VERS 13 /* Set version number */
|
#define CLGET_PROG 14 /* Get program number */
|
#define CLGET_PROG 14 /* Get program number */
|
#define CLSET_PROG 15 /* Set program number */
|
#define CLSET_PROG 15 /* Set program number */
|
#define CLSET_SVC_ADDR 16 /* get server's address (netbuf) */
|
#define CLSET_SVC_ADDR 16 /* get server's address (netbuf) */
|
#define CLSET_PUSH_TIMOD 17 /* push timod if not already present */
|
#define CLSET_PUSH_TIMOD 17 /* push timod if not already present */
|
#define CLSET_POP_TIMOD 18 /* pop timod */
|
#define CLSET_POP_TIMOD 18 /* pop timod */
|
/*
|
/*
|
* Connectionless only control operations
|
* Connectionless only control operations
|
*/
|
*/
|
#define CLSET_RETRY_TIMEOUT 4 /* set retry timeout (timeval) */
|
#define CLSET_RETRY_TIMEOUT 4 /* set retry timeout (timeval) */
|
#define CLGET_RETRY_TIMEOUT 5 /* get retry timeout (timeval) */
|
#define CLGET_RETRY_TIMEOUT 5 /* get retry timeout (timeval) */
|
#define CLSET_ASYNC 19
|
#define CLSET_ASYNC 19
|
#define CLSET_CONNECT 20 /* Use connect() for UDP. (int) */
|
#define CLSET_CONNECT 20 /* Use connect() for UDP. (int) */
|
|
|
/*
|
/*
|
* void
|
* void
|
* CLNT_DESTROY(rh);
|
* CLNT_DESTROY(rh);
|
* CLIENT *rh;
|
* CLIENT *rh;
|
*/
|
*/
|
#define CLNT_DESTROY(rh) ((*(rh)->cl_ops->cl_destroy)(rh))
|
#define CLNT_DESTROY(rh) ((*(rh)->cl_ops->cl_destroy)(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 accessible on every rpc
|
* RPCTEST is a test program which is accessible on every rpc
|
* transport/port. It is used for testing, performance evaluation,
|
* transport/port. It is used for testing, performance evaluation,
|
* and network administration.
|
* and network administration.
|
*/
|
*/
|
|
|
#define RPCTEST_PROGRAM ((rpcprog_t)1)
|
#define RPCTEST_PROGRAM ((rpcprog_t)1)
|
#define RPCTEST_VERSION ((rpcvers_t)1)
|
#define RPCTEST_VERSION ((rpcvers_t)1)
|
#define RPCTEST_NULL_PROC ((rpcproc_t)2)
|
#define RPCTEST_NULL_PROC ((rpcproc_t)2)
|
#define RPCTEST_NULL_BATCH_PROC ((rpcproc_t)3)
|
#define RPCTEST_NULL_BATCH_PROC ((rpcproc_t)3)
|
|
|
/*
|
/*
|
* By convention, procedure 0 takes null arguments and returns them
|
* By convention, procedure 0 takes null arguments and returns them
|
*/
|
*/
|
|
|
#define NULLPROC ((rpcproc_t)0)
|
#define NULLPROC ((rpcproc_t)0)
|
|
|
/*
|
/*
|
* Below are the client handle creation routines for the various
|
* Below are the client handle creation routines for the various
|
* implementations of client side rpc. They can return NULL if a
|
* implementations of client side rpc. They can return NULL if a
|
* creation failure occurs.
|
* creation failure occurs.
|
*/
|
*/
|
|
|
/*
|
/*
|
* Generic client creation routine. Supported protocols are those that
|
* Generic client creation routine. Supported protocols are those that
|
* belong to the nettype namespace (/etc/netconfig).
|
* belong to the nettype namespace (/etc/netconfig).
|
* CLIENT *
|
* CLIENT *
|
* clnt_create(host, prog, vers, prot);
|
* clnt_create(host, prog, vers, prot);
|
* const char *host; -- hostname
|
* const char *host; -- hostname
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* const rpcvers_t vers; -- version number
|
* const rpcvers_t vers; -- version number
|
* const char *prot; -- protocol
|
* const char *prot; -- protocol
|
*/
|
*/
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern CLIENT *clnt_create(const char *, const rpcprog_t, const rpcvers_t,
|
extern CLIENT *clnt_create(const char *, const rpcprog_t, const rpcvers_t,
|
const char *);
|
const char *);
|
/*
|
/*
|
*
|
*
|
* const char *hostname; -- hostname
|
* const char *hostname; -- hostname
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* const rpcvers_t vers; -- version number
|
* const rpcvers_t vers; -- version number
|
* const char *nettype; -- network type
|
* const char *nettype; -- network type
|
*/
|
*/
|
|
|
/*
|
/*
|
* Generic client creation routine. Supported protocols are which belong
|
* Generic client creation routine. Supported protocols are which belong
|
* to the nettype name space.
|
* to the nettype name space.
|
*/
|
*/
|
extern CLIENT *clnt_create_vers(const char *, const rpcprog_t, rpcvers_t *,
|
extern CLIENT *clnt_create_vers(const char *, const rpcprog_t, rpcvers_t *,
|
const rpcvers_t, const rpcvers_t,
|
const rpcvers_t, const rpcvers_t,
|
const char *);
|
const char *);
|
/*
|
/*
|
* const char *host; -- hostname
|
* const char *host; -- hostname
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* rpcvers_t *vers_out; -- servers highest available version
|
* rpcvers_t *vers_out; -- servers highest available version
|
* const rpcvers_t vers_low; -- low version number
|
* const rpcvers_t vers_low; -- low version number
|
* const rpcvers_t vers_high; -- high version number
|
* const rpcvers_t vers_high; -- high version number
|
* const char *nettype; -- network type
|
* const char *nettype; -- network type
|
*/
|
*/
|
|
|
|
|
/*
|
/*
|
* Generic client creation routine. It takes a netconfig structure
|
* Generic client creation routine. It takes a netconfig structure
|
* instead of nettype
|
* instead of nettype
|
*/
|
*/
|
extern CLIENT *clnt_tp_create(const char *, const rpcprog_t,
|
extern CLIENT *clnt_tp_create(const char *, const rpcprog_t,
|
const rpcvers_t, const struct netconfig *);
|
const rpcvers_t, const struct netconfig *);
|
/*
|
/*
|
* const char *hostname; -- hostname
|
* const char *hostname; -- hostname
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* const rpcvers_t vers; -- version number
|
* const rpcvers_t vers; -- version number
|
* const struct netconfig *netconf; -- network config structure
|
* const struct netconfig *netconf; -- network config structure
|
*/
|
*/
|
|
|
/*
|
/*
|
* Generic TLI create routine. Only provided for compatibility.
|
* Generic TLI create routine. Only provided for compatibility.
|
*/
|
*/
|
|
|
extern CLIENT *clnt_tli_create(const int, const struct netconfig *,
|
extern CLIENT *clnt_tli_create(const int, const struct netconfig *,
|
const struct netbuf *, const rpcprog_t,
|
const struct netbuf *, const rpcprog_t,
|
const rpcvers_t, const u_int, const u_int);
|
const rpcvers_t, const u_int, const u_int);
|
/*
|
/*
|
* const register int fd; -- fd
|
* const register int fd; -- fd
|
* const struct netconfig *nconf; -- netconfig structure
|
* const struct netconfig *nconf; -- netconfig structure
|
* const struct netbuf *svcaddr; -- servers address
|
* const struct netbuf *svcaddr; -- servers address
|
* const u_long prog; -- program number
|
* const u_long prog; -- program number
|
* const u_long vers; -- version number
|
* const u_long vers; -- version number
|
* const u_int sendsz; -- send size
|
* const u_int sendsz; -- send size
|
* const u_int recvsz; -- recv size
|
* const u_int recvsz; -- recv size
|
*/
|
*/
|
|
|
/*
|
/*
|
* Low level clnt create routine for connectionful transports, e.g. tcp.
|
* Low level clnt create routine for connectionful transports, e.g. tcp.
|
*/
|
*/
|
extern CLIENT *clnt_vc_create(const int, const struct netbuf *,
|
extern CLIENT *clnt_vc_create(const int, const struct netbuf *,
|
const rpcprog_t, const rpcvers_t,
|
const rpcprog_t, const rpcvers_t,
|
const u_int, const u_int);
|
const u_int, const u_int);
|
/*
|
/*
|
* Added for compatibility to old rpc 4.0. Obsoleted by clnt_vc_create().
|
* Added for compatibility to old rpc 4.0. Obsoleted by clnt_vc_create().
|
*/
|
*/
|
extern CLIENT *clntunix_create(struct sockaddr_un *,
|
extern CLIENT *clntunix_create(struct sockaddr_un *,
|
u_long, u_long, int *, u_int, u_int);
|
u_long, u_long, int *, u_int, u_int);
|
/*
|
/*
|
* const int fd; -- open file descriptor
|
* const int fd; -- open file descriptor
|
* const struct netbuf *svcaddr; -- servers address
|
* const struct netbuf *svcaddr; -- servers address
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* const rpcvers_t vers; -- version number
|
* const rpcvers_t vers; -- version number
|
* const u_int sendsz; -- buffer recv size
|
* const u_int sendsz; -- buffer recv size
|
* const u_int recvsz; -- buffer send size
|
* const u_int recvsz; -- buffer send size
|
*/
|
*/
|
|
|
/*
|
/*
|
* Low level clnt create routine for connectionless transports, e.g. udp.
|
* Low level clnt create routine for connectionless transports, e.g. udp.
|
*/
|
*/
|
extern CLIENT *clnt_dg_create(const int, const struct netbuf *,
|
extern CLIENT *clnt_dg_create(const int, const struct netbuf *,
|
const rpcprog_t, const rpcvers_t,
|
const rpcprog_t, const rpcvers_t,
|
const u_int, const u_int);
|
const u_int, const u_int);
|
/*
|
/*
|
* const int fd; -- open file descriptor
|
* const int fd; -- open file descriptor
|
* const struct netbuf *svcaddr; -- servers address
|
* const struct netbuf *svcaddr; -- servers address
|
* const rpcprog_t program; -- program number
|
* const rpcprog_t program; -- program number
|
* const rpcvers_t version; -- version number
|
* const rpcvers_t version; -- version number
|
* const u_int sendsz; -- buffer recv size
|
* const u_int sendsz; -- buffer recv size
|
* const u_int recvsz; -- buffer send size
|
* const u_int recvsz; -- buffer send size
|
*/
|
*/
|
|
|
/*
|
/*
|
* Memory based rpc (for speed check and testing)
|
* Memory based rpc (for speed check and testing)
|
* CLIENT *
|
* CLIENT *
|
* clnt_raw_create(prog, vers)
|
* clnt_raw_create(prog, vers)
|
* u_long prog;
|
* u_long prog;
|
* u_long vers;
|
* u_long vers;
|
*/
|
*/
|
extern CLIENT *clnt_raw_create(rpcprog_t, rpcvers_t);
|
extern CLIENT *clnt_raw_create(rpcprog_t, rpcvers_t);
|
|
|
__END_DECLS
|
__END_DECLS
|
|
|
|
|
/*
|
/*
|
* Print why creation failed
|
* Print why creation failed
|
*/
|
*/
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern void clnt_pcreateerror(const char *); /* stderr */
|
extern void clnt_pcreateerror(const char *); /* stderr */
|
extern char *clnt_spcreateerror(const char *); /* string */
|
extern char *clnt_spcreateerror(const char *); /* string */
|
__END_DECLS
|
__END_DECLS
|
|
|
/*
|
/*
|
* Like clnt_perror(), but is more verbose in its output
|
* Like clnt_perror(), but is more verbose in its output
|
*/
|
*/
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern void clnt_perrno(enum clnt_stat); /* stderr */
|
extern void clnt_perrno(enum clnt_stat); /* stderr */
|
extern char *clnt_sperrno(enum clnt_stat); /* string */
|
extern char *clnt_sperrno(enum clnt_stat); /* string */
|
__END_DECLS
|
__END_DECLS
|
|
|
/*
|
/*
|
* Print an English error message, given the client error code
|
* Print an English error message, given the client error code
|
*/
|
*/
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern void clnt_perror(CLIENT *, const char *); /* stderr */
|
extern void clnt_perror(CLIENT *, const char *); /* stderr */
|
extern char *clnt_sperror(CLIENT *, const char *); /* string */
|
extern char *clnt_sperror(CLIENT *, const char *); /* string */
|
__END_DECLS
|
__END_DECLS
|
|
|
|
|
/*
|
/*
|
* If a creation fails, the following allows the user to figure out why.
|
* If a creation fails, the following allows the user to figure out why.
|
*/
|
*/
|
struct rpc_createerr {
|
struct rpc_createerr {
|
enum clnt_stat cf_stat;
|
enum clnt_stat cf_stat;
|
struct rpc_err cf_error; /* useful when cf_stat == RPC_PMAPFAILURE */
|
struct rpc_err cf_error; /* useful when cf_stat == RPC_PMAPFAILURE */
|
};
|
};
|
|
|
#ifdef _THREAD_SAFE
|
#ifdef _THREAD_SAFE
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern struct rpc_createerr *__rpc_createerr(void);
|
extern struct rpc_createerr *__rpc_createerr(void);
|
__END_DECLS
|
__END_DECLS
|
#define rpc_createerr (*(__rpc_createerr()))
|
#define rpc_createerr (*(__rpc_createerr()))
|
#else
|
#else
|
extern struct rpc_createerr rpc_createerr;
|
extern struct rpc_createerr rpc_createerr;
|
#endif /* _THREAD_SAFE */
|
#endif /* _THREAD_SAFE */
|
|
|
/*
|
/*
|
* The simplified interface:
|
* The simplified interface:
|
* enum clnt_stat
|
* enum clnt_stat
|
* rpc_call(host, prognum, versnum, procnum, inproc, in, outproc, out, nettype)
|
* rpc_call(host, prognum, versnum, procnum, inproc, in, outproc, out, nettype)
|
* const char *host;
|
* const char *host;
|
* const rpcprog_t prognum;
|
* const rpcprog_t prognum;
|
* const rpcvers_t versnum;
|
* const rpcvers_t versnum;
|
* const rpcproc_t procnum;
|
* const rpcproc_t procnum;
|
* const xdrproc_t inproc, outproc;
|
* const xdrproc_t inproc, outproc;
|
* const char *in;
|
* const char *in;
|
* char *out;
|
* char *out;
|
* const char *nettype;
|
* const char *nettype;
|
*/
|
*/
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern enum clnt_stat rpc_call(const char *, const rpcprog_t,
|
extern enum clnt_stat rpc_call(const char *, const rpcprog_t,
|
const rpcvers_t, const rpcproc_t,
|
const rpcvers_t, const rpcproc_t,
|
const xdrproc_t, const char *,
|
const xdrproc_t, const char *,
|
const xdrproc_t, char *, const char *);
|
const xdrproc_t, char *, const char *);
|
__END_DECLS
|
__END_DECLS
|
|
|
/*
|
/*
|
* RPC broadcast interface
|
* RPC broadcast interface
|
* The call is broadcasted to all locally connected nets.
|
* The call is broadcasted to all locally connected nets.
|
*
|
*
|
* extern enum clnt_stat
|
* extern enum clnt_stat
|
* rpc_broadcast(prog, vers, proc, xargs, argsp, xresults, resultsp,
|
* rpc_broadcast(prog, vers, proc, xargs, argsp, xresults, resultsp,
|
* eachresult, nettype)
|
* eachresult, nettype)
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* const rpcvers_t vers; -- version number
|
* const rpcvers_t vers; -- version number
|
* const rpcproc_t proc; -- procedure number
|
* const rpcproc_t proc; -- procedure number
|
* const xdrproc_t xargs; -- xdr routine for args
|
* const xdrproc_t xargs; -- xdr routine for args
|
* caddr_t argsp; -- pointer to args
|
* caddr_t argsp; -- pointer to args
|
* const xdrproc_t xresults; -- xdr routine for results
|
* const xdrproc_t xresults; -- xdr routine for results
|
* caddr_t resultsp; -- pointer to results
|
* caddr_t resultsp; -- pointer to results
|
* const resultproc_t eachresult; -- call with each result
|
* const resultproc_t eachresult; -- call with each result
|
* const char *nettype; -- Transport type
|
* const char *nettype; -- Transport type
|
*
|
*
|
* For each valid response received, the procedure eachresult is called.
|
* For each valid response received, the procedure eachresult is called.
|
* Its form is:
|
* Its form is:
|
* done = eachresult(resp, raddr, nconf)
|
* done = eachresult(resp, raddr, nconf)
|
* bool_t done;
|
* bool_t done;
|
* caddr_t resp;
|
* caddr_t resp;
|
* struct netbuf *raddr;
|
* struct netbuf *raddr;
|
* struct netconfig *nconf;
|
* struct netconfig *nconf;
|
* where resp points to the results of the call and raddr is the
|
* where resp points to the results of the call and raddr is the
|
* address if the responder to the broadcast. nconf is the transport
|
* address if the responder to the broadcast. nconf is the transport
|
* on which the response was received.
|
* on which the response was received.
|
*
|
*
|
* extern enum clnt_stat
|
* extern enum clnt_stat
|
* rpc_broadcast_exp(prog, vers, proc, xargs, argsp, xresults, resultsp,
|
* rpc_broadcast_exp(prog, vers, proc, xargs, argsp, xresults, resultsp,
|
* eachresult, inittime, waittime, nettype)
|
* eachresult, inittime, waittime, nettype)
|
* const rpcprog_t prog; -- program number
|
* const rpcprog_t prog; -- program number
|
* const rpcvers_t vers; -- version number
|
* const rpcvers_t vers; -- version number
|
* const rpcproc_t proc; -- procedure number
|
* const rpcproc_t proc; -- procedure number
|
* const xdrproc_t xargs; -- xdr routine for args
|
* const xdrproc_t xargs; -- xdr routine for args
|
* caddr_t argsp; -- pointer to args
|
* caddr_t argsp; -- pointer to args
|
* const xdrproc_t xresults; -- xdr routine for results
|
* const xdrproc_t xresults; -- xdr routine for results
|
* caddr_t resultsp; -- pointer to results
|
* caddr_t resultsp; -- pointer to results
|
* const resultproc_t eachresult; -- call with each result
|
* const resultproc_t eachresult; -- call with each result
|
* const int inittime; -- how long to wait initially
|
* const int inittime; -- how long to wait initially
|
* const int waittime; -- maximum time to wait
|
* const int waittime; -- maximum time to wait
|
* const char *nettype; -- Transport type
|
* const char *nettype; -- Transport type
|
*/
|
*/
|
|
|
typedef bool_t (*resultproc_t)(caddr_t, ...);
|
typedef bool_t (*resultproc_t)(caddr_t, ...);
|
|
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
extern enum clnt_stat rpc_broadcast(const rpcprog_t, const rpcvers_t,
|
extern enum clnt_stat rpc_broadcast(const rpcprog_t, const rpcvers_t,
|
const rpcproc_t, const xdrproc_t,
|
const rpcproc_t, const xdrproc_t,
|
caddr_t, const xdrproc_t, caddr_t,
|
caddr_t, const xdrproc_t, caddr_t,
|
const resultproc_t, const char *);
|
const resultproc_t, const char *);
|
extern enum clnt_stat rpc_broadcast_exp(const rpcprog_t, const rpcvers_t,
|
extern enum clnt_stat rpc_broadcast_exp(const rpcprog_t, const rpcvers_t,
|
const rpcproc_t, const xdrproc_t,
|
const rpcproc_t, const xdrproc_t,
|
caddr_t, const xdrproc_t, caddr_t,
|
caddr_t, const xdrproc_t, caddr_t,
|
const resultproc_t, const int,
|
const resultproc_t, const int,
|
const int, const char *);
|
const int, const char *);
|
__END_DECLS
|
__END_DECLS
|
|
|
/* For backward compatibility */
|
/* For backward compatibility */
|
#include <rpc/clnt_soc.h>
|
#include <rpc/clnt_soc.h>
|
|
|
#endif /* !_RPC_CLNT_H_ */
|
#endif /* !_RPC_CLNT_H_ */
|
|
|
