[BACK]Return to aitrpc.h CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc

Diff for /libaitrpc/inc/aitrpc.h between versions 1.3.2.1 and 1.4.2.2

version 1.3.2.1, 2011/08/29 23:26:56 version 1.4.2.2, 2011/09/07 09:42:46
Line 59  SUCH DAMAGE. Line 59  SUCH DAMAGE.
 #include <aitio.h>  #include <aitio.h>
   
   
#define RPC_VERSION             1#define RPC_VERSION             2
 #define RPC_DEFPORT             2611  #define RPC_DEFPORT             2611
   
   
Line 79  SUCH DAMAGE. Line 79  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;
   
   
Line 94  typedef enum { Line 94  typedef enum {
                                         } 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(22, "Error:: different number of arguments!\n"); \
                                                         return -1; \                                                          return -1; \
                                                 } \                                                  } \
Line 116  typedef struct { Line 116  typedef struct {
 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];
   
        int8_t                  func_args;        array_t                 *func_vars;
        ait_val_t                *func_vars; 
   
         void                    *func_parent;          void                    *func_parent;
         struct tagRPCFunc       *func_next;          struct tagRPCFunc       *func_next;
Line 133  struct tagRPCCall { Line 132  struct tagRPCCall {
         rpc_sess_t      call_session;          rpc_sess_t      call_session;
         uint16_t        call_tag;          uint16_t        call_tag;
         uint32_t        call_hash;          uint32_t        call_hash;
        uint8_t             call_argc;        uint16_t        call_argc;
 } __packed;  } __packed;
   
 /* Network RPC packet - Server response */  /* Network RPC packet - Server response */
Line 144  struct tagRPCRet { Line 143  struct tagRPCRet {
         uint32_t        ret_hash;          uint32_t        ret_hash;
         int32_t         ret_retcode;          int32_t         ret_retcode;
         int32_t         ret_errno;          int32_t         ret_errno;
        uint8_t             ret_argc;        uint16_t        ret_argc;
 } __packed;  } __packed;
   
 /* Network BLOB packet - Header */  /* Network BLOB packet - Header */
Line 165  typedef struct { Line 164  typedef struct {
         pthread_t       cli_tid;        // TID of thread          pthread_t       cli_tid;        // TID of thread
   
         void            *cli_parent;    // pointer to parent rpc_srv_t for server or to rpc_sess_t for client          void            *cli_parent;    // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
           int             cli_netbuf;     // size of network buffer size
 } rpc_cli_t;  } rpc_cli_t;
   
   
Line 181  typedef struct tagBLOB { Line 181  typedef struct tagBLOB {
 typedef struct {  typedef struct {
         rpc_sess_t      srv_session;    // RPC session registration info          rpc_sess_t      srv_session;    // RPC session registration info
         int             srv_numcli;     // maximum concurent client connections          int             srv_numcli;     // maximum concurent client connections
           int             srv_netbuf;     // size of network buffer size
   
         rpc_cli_t       srv_server;     // RPC server socket          rpc_cli_t       srv_server;     // RPC server socket
         rpc_cli_t       *srv_clients;   // connected rpc client sockets          rpc_cli_t       *srv_clients;   // connected rpc client sockets
Line 211  typedef struct { Line 212  typedef struct {
  * @arg3 = input array with values from RPC call execution request   * @arg3 = input array with values from RPC call execution request
  * return: -1 error or >-1 success execution   * return: -1 error or >-1 success execution
  */   */
typedef int (*rpc_callback_t)(rpc_func_t *, int, ait_val_t *);typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
   
   
 // -----------------------------------------------------------------------  // -----------------------------------------------------------------------
Line 224  inline int rpc_GetErrno(); Line 225  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 231  inline const char *rpc_GetError(); Line 248  inline const char *rpc_GetError();
  * @regProgID = ProgramID for authentication & recognition   * @regProgID = ProgramID for authentication & recognition
  * @regProcID = ProcessID for authentication & recognition   * @regProcID = ProcessID for authentication & recognition
  * @concurentClients = Concurent clients at same time to this server   * @concurentClients = Concurent clients at same time to this server
    * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
  * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL   * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
  * @csHost = Host name or address for bind server, if NULL any address   * @csHost = Host name or address for bind server, if NULL any address
  * @Port = Port for bind server, if Port == 0 default port is selected   * @Port = Port for bind server, if Port == 0 default port is selected
  * return: NULL == error or !=NULL bind and created RPC server instance   * return: NULL == error or !=NULL bind and created RPC server instance
  */   */
 rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients,   rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients, 
                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 266  int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, Line 292  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 281  int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv) Line 315  int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv)
  * return: -1 error or 0 register ok   * return: -1 error or 0 register ok
  */   */
 int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc,   int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, 
                unsigned char args);                unsigned short args);
 /*  /*
  * rpc_srv_unregisterCall() Unregister call from RPC server   * rpc_srv_unregisterCall() Unregister call from RPC server
  * @srv = RPC Server instance   * @srv = RPC Server instance
Line 310  inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restr Line 344  inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restr
  * rpc_srv_execCall() Execute registered call from RPC server   * rpc_srv_execCall() Execute registered call from RPC server
  * @call = Register RPC call   * @call = Register RPC call
  * @rpc = IN RPC call structure   * @rpc = IN RPC call structure
 * @args = IN RPC call array of rpc values * @args = IN RPC calling arguments from RPC client
  * return: -1 error, !=-1 ok   * return: -1 error, !=-1 ok
  */   */
 int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,   int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, 
                ait_val_t * __restrict args);                array_t * __restrict args);
   
   
 /*  /*
  * 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 ait_val_t *rpc_srv_returnVars(rpc_func_t * __restrict call, int varnum);  
 /*  
  * rpc_srv_allocVars() Allocate array for call variables,    * rpc_srv_allocVars() Allocate array for call variables, 
                                 if already allocated memory for RPC call reallocate used space                                  if already allocated memory for RPC call reallocate used space
  * @call = RPC function call   * @call = RPC function call
Line 333  inline ait_val_t *rpc_srv_returnVars(rpc_func_t * __re Line 359  inline ait_val_t *rpc_srv_returnVars(rpc_func_t * __re
  * return: -1 error, !=-1 return varnum value   * return: -1 error, !=-1 return varnum value
  */   */
 inline int rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum);  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 * rpc_srv_destroyVars() Destroy variables of array & array
  * @call = RPC function call   * @call = RPC function call
 * return: -1 error, !=-1 Returned number of cleaned RPC variables * return: -1 error, !=-1 Returne remained variables
  */   */
inline int rpc_srv_zeroVars(rpc_func_t * __restrict call);inline int rpc_srv_destroyVars(rpc_func_t * __restrict call);
 /*  /*
    * rpc_srv_freeVals() Clean values from variables of array
    * @call = RPC function call
    * return: -1 error, !=-1 Returned number of cleaned variables
    */
   inline int rpc_srv_freeVals(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
  * return: -1 error, !=-1 Returned number of copied RPC variables   * return: -1 error, !=-1 Returned number of copied RPC variables
  */   */
inline int rpc_srv_copyVars(rpc_func_t * __restrict call, ait_val_t ** __restrict newvars);inline int rpc_srv_copyVars(rpc_func_t * __restrict call, array_t ** __restrict newvars);
 /*  /*
  * rpc_srv_getVars() Get variables array for RPC call   * rpc_srv_getVars() Get variables array for RPC call
  * @call = RPC function call   * @call = RPC function call
  * @vars = Returned variables array, may be NULL   * @vars = Returned variables array, may be NULL
  * return: -1 error, !=-1 Number of returned variables   * return: -1 error, !=-1 Number of returned variables
  */   */
inline int rpc_srv_getVars(rpc_func_t * __restrict call, ait_val_t ** __restrict vars);inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);
   
   
 /*  /*
Line 421  int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_b Line 452  int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_b
  */   */
 int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);  int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
   
   /* CLIENT part of functions */
   
 /*  /*
  * rpc_cli_sendBLOB() Send BLOB to server   * rpc_cli_sendBLOB() Send BLOB to server
  * @cli = Client instance   * @cli = Client instance
Line 436  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v Line 469  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 451  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va Line 484  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 461  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, Line 494  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
  * rpc_cli_openClient() Connect to RPC Server   * rpc_cli_openClient() Connect to RPC Server
  * @ProgID = ProgramID for RPC session request   * @ProgID = ProgramID for RPC session request
  * @ProcID = ProcessID for RPC session request   * @ProcID = ProcessID for RPC session request
    * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
  * @family = Family socket type, AF_INET or AF_INET6   * @family = Family socket type, AF_INET or AF_INET6
  * @csHost = Host name or IP address for bind server   * @csHost = Host name or IP address for bind server
  * @Port = Port for bind server, if Port == 0 default port is selected   * @Port = Port for bind server, if Port == 0 default port is selected
  * return: NULL == error or !=NULL connection to RPC server established   * return: NULL == error or !=NULL connection to RPC server established
  */   */
rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, int netBuf, 
                 u_short family, const char *csHost, u_short Port);                  u_short family, const char *csHost, u_short Port);
 /*  /*
  * rpc_cli_closeClient() Close connection to RPC server and free resources   * rpc_cli_closeClient() Close connection to RPC server and free resources
Line 479  void rpc_cli_closeClient(rpc_cli_t * __restrict cli); Line 513  void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
  * @cli = RPC Client session   * @cli = RPC Client session
  * @csModule = Module name, if NULL self binary   * @csModule = Module name, if NULL self binary
  * @csFunc = Function name for execute   * @csFunc = Function name for execute
  * @in_argc = IN count of arguments  
  * @in_vars = IN RPC call array of rpc values   * @in_vars = IN RPC call array of rpc values
 * @out_argc = OUT returned count of arguments * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
 * @out_vars = OUT returned array of rpc values, must be free after use (see rpc_cli_freeVals()) 
  * return: -1 error or != -1 ok result   * return: -1 error or != -1 ok result
  */   */
int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, int in_argc, int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, 
                ait_val_t * __restrict in_vars, int *out_argc, ait_val_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   * rpc_cli_freeVals() Free ait_val_t array returned from RPC call
 * @args = Number of arguments in array * @vars = Variable array
 * @vars = Value elements 
  * return: none   * return: none
  */   */
inline void rpc_cli_freeVals(int args, ait_val_t * __restrict vars);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.1  
changed lines
  Added in v.1.4.2.2

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