Diff for /libaitrpc/inc/aitrpc.h between versions 1.3.2.4 and 1.5.2.1

version 1.3.2.4, 2011/08/31 17:11:58 version 1.5.2.1, 2012/03/12 12:33:32
Line 12  terms: Line 12  terms:
 All of the documentation and software included in the ELWIX and AITNET  All of the documentation and software included in the ELWIX and AITNET
 Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>  Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   
Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
         by Michael Pounov <misho@elwix.org>.  All rights reserved.          by Michael Pounov <misho@elwix.org>.  All rights reserved.
   
 Redistribution and use in source and binary forms, with or without  Redistribution and use in source and binary forms, with or without
Line 50  SUCH DAMAGE. Line 50  SUCH DAMAGE.
 #include <assert.h>  #include <assert.h>
 #include <stdlib.h>  #include <stdlib.h>
 #include <string.h>  #include <string.h>
   #include <errno.h>
 #include <sys/types.h>  #include <sys/types.h>
 #include <sys/param.h>  #include <sys/param.h>
 #if !defined(__NetBSD__)  #if !defined(__NetBSD__)
Line 59  SUCH DAMAGE. Line 60  SUCH DAMAGE.
 #include <aitio.h>  #include <aitio.h>
   
   
#define RPC_VERSION             1#define RPC_VERSION             3
 #define RPC_DEFPORT             2611  #define RPC_DEFPORT             2611
   
   
Line 79  SUCH DAMAGE. Line 80  SUCH DAMAGE.
 /* RPC types */  /* RPC types */
   
 typedef enum {  typedef enum {
        disable, enable, kill,         /* for blob.state */        disable, enable, running, kill,         /* for blob.state */
        ok, error,              /* for blob reply */        ok, error,                              /* for blob reply */
        get, set, unset         /* for blob request */        get, set, unset                         /* for blob request */
 } cmd_type_t;  } cmd_type_t;
   
   
 #define RPC_CALLBACK_CHECK_INPUT(_f)    do { \  #define RPC_CALLBACK_CHECK_INPUT(_f)    do { \
                                                 assert((_f)); \                                                  assert((_f)); \
                                                 if (!(_f)) { \                                                  if (!(_f)) { \
                                                        rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \                                                        rpc_SetErr(EINVAL, \
                                                                         "Invalid callback parameters ..."); \
                                                         return -1; \                                                          return -1; \
                                                 } \                                                  } \
                                         } while (0)                                          } while (0)
 #define RPC_CALLBACK_CHK_ARGS(_f, _n)   do { \  #define RPC_CALLBACK_CHK_ARGS(_f, _n)   do { \
                                                 RPC_CALLBACK_CHECK_INPUT((_f)); \                                                  RPC_CALLBACK_CHECK_INPUT((_f)); \
                                                if ((_f) && (_f)->func_args != _n) { \                                                if ((_f) && io_arraySize((_f)->func_vars) < _n) { \
                                                        rpc_SetErr(22, "Error:: different number of arguments!\n"); \                                                        rpc_SetErr(EINVAL, \
                                                                         "Not enough number of arguments!"); \
                                                         return -1; \                                                          return -1; \
                                                 } \                                                  } \
                                         } while (0)                                          } while (0)
Line 105  typedef enum { Line 108  typedef enum {
   
 typedef struct {  typedef struct {
         uint8_t         sess_version;          uint8_t         sess_version;
           uint8_t         sess_timeout;
         uint32_t        sess_program;          uint32_t        sess_program;
         uint32_t        sess_process;          uint32_t        sess_process;
 } __packed rpc_sess_t;  } __packed rpc_sess_t;
Line 112  typedef struct { Line 116  typedef struct {
   
 /* Server managment RPC functions ... */  /* Server managment RPC functions ... */
   
// RPC function registration element!/* RPC function registration element! */
 typedef struct tagRPCFunc {  typedef struct tagRPCFunc {
         uint16_t                func_tag;          uint16_t                func_tag;
         uint32_t                func_hash;          uint32_t                func_hash;
        int8_t                        func_file[MAXPATHLEN];        char                        func_file[MAXPATHLEN];
        int8_t                        func_name[UCHAR_MAX + 1];        char                        func_name[UCHAR_MAX + 1];
   
         uint16_t                func_args;  
         array_t                 *func_vars;          array_t                 *func_vars;
   
         void                    *func_parent;          void                    *func_parent;
Line 160  struct tagBLOBHdr { Line 163  struct tagBLOBHdr {
 /* Network RPC client & server elements */  /* Network RPC client & server elements */
   
 typedef struct {  typedef struct {
        struct sockaddr       cli_sa;         // host info        io_sockaddr_t        cli_sa;         // host info
         int             cli_sock;       // socket fd          int             cli_sock;       // socket fd
         pthread_t       cli_tid;        // TID of thread          pthread_t       cli_tid;        // TID of thread
   
Line 169  typedef struct { Line 172  typedef struct {
 } rpc_cli_t;  } rpc_cli_t;
   
   
// BLOB registration element!/* BLOB registration element! */
 typedef struct tagBLOB {  typedef struct tagBLOB {
         uint32_t        blob_var;          uint32_t        blob_var;
   
Line 226  inline int rpc_GetErrno(); Line 229  inline int rpc_GetErrno();
 inline const char *rpc_GetError();  inline const char *rpc_GetError();
   
   
   /*
    * rpc_chkPktSession() Check session in RPC packet
    * @p = packet session
    * @s = active session
    * return: -1 error or 0 ok
    */
   inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
   /*
    * rpc_addPktSession() Add session into RPC packet
    * @p = packet session
    * @s = active session
    * return: -1 error or 0 ok
    */
   inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
   
   
 /* RPC Server side functions */  /* RPC Server side functions */
   
 /*  /*
Line 243  rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int r Line 262  rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int r
                 int netBuf, u_short family, const char *csHost, u_short Port);                  int netBuf, u_short family, const char *csHost, u_short Port);
 /*  /*
  * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources   * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources
 * @srv = RPC Server instance * @psrv = RPC Server instance
  * return: none   * return: none
  */   */
void rpc_srv_endServer(rpc_srv_t * __restrict srv);void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
 /*  /*
 * rpc_srv_execServer() Execute Main server loop and wait for clients requests * rpc_srv_loopServer() Execute Main server loop and wait for clients requests
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * return: -1 error or 0 ok, infinite loop ...   * return: -1 error or 0 ok, infinite loop ...
  */   */
int rpc_srv_execServer(rpc_srv_t * __restrict srv);int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
 #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); pthread_t __tid; \
                                                 pthread_create(&__tid, NULL, (void*(*)(void*)) \
                                                                 rpc_srv_loopServer, (_srv)); \
                                                 if ((_sync)) \
                                                         pthread_join(__tid, (void**) (_sync)); \
                                                 else \
                                                         pthread_detach(__tid); \
                                         } while (0)
   
 /*  /*
  * rpc_srv_initBLOBServer() Init & create BLOB Server   * rpc_srv_initBLOBServer() Init & create BLOB Server
Line 269  int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, Line 296  int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv,
  */   */
 void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);  void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
 /*  /*
 * rpc_srv_execBLOBServer() Execute Main BLOB server loop and wait for clients requests * rpc_srv_loopBLOB() Execute Main BLOB server loop and wait for clients requests
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * return: -1 error or 0 ok, infinite loop ...   * return: -1 error or 0 ok, infinite loop ...
  */   */
int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv);int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
 #define rpc_srv_execBLOBServer(_srv)    do { assert((_srv)); pthread_t __tid; \
                                                 if ((_srv)->srv_blob.state == enable) { \
                                                         pthread_create(&__tid, NULL, (void*(*)(void*)) \
                                                                         rpc_srv_loopBLOB, (_srv)); \
                                                         pthread_detach(__tid); \
                                                         (_srv)->srv_blob.state = running; \
                                                 } \
                                         } while (0)
   
 /*  /*
  * rpc_srv_registerCall() Register call to RPC server   * rpc_srv_registerCall() Register call to RPC server
Line 321  int rpc_srv_execCall(rpc_func_t * __restrict call, str Line 356  int rpc_srv_execCall(rpc_func_t * __restrict call, str
   
   
 /*  /*
  * rpc_srv_returnVars() Init return variables for RPC call and zeroed values  
                                         (for safe handling return values, use this!)  
  * @call = RPC function call  
  * @varnum = Number of return variables  
  * return: NULL error, !=NULL array with return values for RPC call with varnum items  
  */  
 inline array_t *rpc_srv_returnVars(rpc_func_t * __restrict call, int varnum);  
 /*  
  * rpc_srv_allocVars() Allocate array for call variables,   
                                 if already allocated memory for RPC call reallocate used space  
  * @call = RPC function call  
  * @varnum = Number of variables, if ==0 free previous allocated variables  
  * return: -1 error, !=-1 return varnum value  
  */  
 inline int rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum);  
 #define rpc_srv_freeVars(_call) (assert((_call)), rpc_srv_allocVars((_call), 0))  
 /*  
  * rpc_srv_zeroVars() Clean values from variables of RPC call  
  * @call = RPC function call  
  * return: -1 error, !=-1 Returned number of cleaned RPC variables  
  */  
 inline int rpc_srv_zeroVars(rpc_func_t * __restrict call);  
 /*  
  * rpc_srv_copyVars() Copy variables for RPC call to new variable array   * rpc_srv_copyVars() Copy variables for RPC call to new variable array
  * @call = RPC function call   * @call = RPC function call
  * @newvars = New allocated variables array, must be free after use   * @newvars = New allocated variables array, must be free after use
Line 441  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v Line 453  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v
  * @data = BLOB data, must be free after use!   * @data = BLOB data, must be free after use!
  * return: -1 error, 0 ok, 1 remote error   * return: -1 error, 0 ok, 1 remote error
  */   */
int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** data);int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
 /*  /*
  * rpc_cli_delBLOB() Delete BLOB from server   * rpc_cli_delBLOB() Delete BLOB from server
  * @cli = Client instance   * @cli = Client instance
Line 456  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va Line 468  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va
  * @data = BLOB data, must be free after use!   * @data = BLOB data, must be free after use!
  * return: -1 error, 0 ok, >0 remote error   * return: -1 error, 0 ok, >0 remote error
  */   */
inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** data);inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
   
   
   
Line 491  void rpc_cli_closeClient(rpc_cli_t * __restrict cli); Line 503  void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
  */   */
 int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc,   int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, 
                 array_t * __restrict in_vars, array_t ** __restrict out_vars);                  array_t * __restrict in_vars, array_t ** __restrict out_vars);
 /*  
  * rpc_cli_freeVals() Free ait_val_t array returned from RPC call  
  * @vars = Variable array  
  * return: none  
  */  
 inline void rpc_cli_freeVals(array_t ** __restrict vars);  
 /*  
  * rpc_cli_allocVals() Allocate ait_val_t array for RPC call  
  * @args = Number of arguments  
  * return: =NULL error or !=NULL allocated array  
  */  
 inline array_t *rpc_cli_allocVals(unsigned short args);  
   
   
 /*  /*

Removed from v.1.3.2.4  
changed lines
  Added in v.1.5.2.1


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>