sunrpc/rpc/rpc.h

   1 /* @(#)rpc.h    2.3 88/08/10 4.0 RPCSRC; from 1.9 88/02/08 SMI */
   2 /*
   3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   4  * unrestricted use provided that this legend is included on all tape
   5  * media and as a part of the software program in whole or part.  Users
   6  * may copy or modify Sun RPC without charge, but are not authorized
   7  * to license or distribute it to anyone else except as part of a product or
   8  * program developed by the user.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30
  31 /*
  32  * rpc.h, Just includes the billions of rpc header files necessary to
  33  * do remote procedure calling.
  34  *
  35  * Copyright (C) 1984, Sun Microsystems, Inc.
  36  */
  37
  38 #ifndef _RPC_RPC_H
  39 #define _RPC_RPC_H 1
  40
  41 #include <rpc/types.h>          /* some typedefs */
  42 #include <netinet/in.h>
  43
  44 /* external data representation interfaces */
  45 #include <rpc/xdr.h>            /* generic (de)serializer */
  46
  47 /* Client side only authentication */
  48 #include <rpc/auth.h>           /* generic authenticator (client side) */
  49
  50 /* Client side (mostly) remote procedure call */
  51 #include <rpc/clnt.h>           /* generic rpc stuff */
  52
  53 /* semi-private protocol headers */
  54 #include <rpc/rpc_msg.h>        /* protocol for rpc messages */
  55 #include <rpc/auth_unix.h>      /* protocol for unix style cred */
  56 #include <rpc/auth_des.h>       /* protocol for des style cred */
  57
  58 /* Server side only remote procedure callee */
  59 #include <rpc/svc.h>            /* service manager and multiplexer */
  60 #include <rpc/svc_auth.h>       /* service side authenticator */
  61
  62 /*
  63  * COMMENT OUT THE NEXT INCLUDE IF RUNNING ON SUN OS OR ON A VERSION
  64  * OF UNIX BASED ON NFSSRC.  These systems will already have the structures
  65  * defined by <rpc/netdb.h> included in <netdb.h>.
  66  */
  67 /* routines for parsing /etc/rpc */
  68 #include <rpc/netdb.h>          /* structures and routines to parse /etc/rpc */
  69
  70 __BEGIN_DECLS
  71
  72 /* Global variables, protected for multi-threaded applications.  */
  73 extern fd_set *__rpc_thread_svc_fdset (void) __attribute__ ((__const__));
  74 #define svc_fdset (*__rpc_thread_svc_fdset ())
  75
  76 extern struct rpc_createerr *__rpc_thread_createerr (void)
  77      __attribute__ ((__const__));
  78 #define get_rpc_createerr() (*__rpc_thread_createerr ())
  79 /* The people who "engineered" RPC should bee punished for naming the
  80    data structure and the variable the same.  We cannot always define the
  81    macro 'rpc_createerr' because this would prevent people from defining
  82    object of type 'struct rpc_createerr'.  So we leave it up to the user
  83    to select transparent replacement also of this variable.  */
  84 #ifdef _RPC_MT_VARS
  85 # define rpc_createerr (*__rpc_thread_createerr ())
  86 #endif
  87
  88 extern struct pollfd **__rpc_thread_svc_pollfd (void)
  89      __attribute__ ((__const__));
  90 #define svc_pollfd (*__rpc_thread_svc_pollfd ())
  91
  92 extern int *__rpc_thread_svc_max_pollfd (void) __attribute__ ((__const__));
  93 #define svc_max_pollfd (*__rpc_thread_svc_max_pollfd ())
  94
  95 __END_DECLS
  96
  97 #endif /* rpc/rpc.h */