[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.8.2.3 and 1.8.2.20

version 1.8.2.3, 2012/05/15 20:49:46 version 1.8.2.20, 2012/05/17 15:18:48
Line 72  SUCH DAMAGE. Line 72  SUCH DAMAGE.
   
 /* RPC builtin registed calls */  /* RPC builtin registed calls */
   
#define CALL_BLOBSHUTDOWN    "rpcBLOBServerShutdown"#define CALL_TAG_MAX         65535
#define CALL_BLOBCLIENTS        "rpcBLOBServerClients" 
#define CALL_BLOBVARS           "rpcBLOBServerVars" 
#define CALL_BLOBSTATE          "rpcBLOBServerState" 
   
#define CALL_SRVSHUTDOWN        "rpcServerShutdown"#define CALL_SRVPING            65534
#define CALL_SRVCLIENTS         "rpcServerClients" 
#define CALL_SRVCALLS           "rpcServerCalls" 
#define CALL_SRVSESSIONS        "rpcServerSessions" 
   
   #define CALL_SRVSHUTDOWN        65533
   #define CALL_SRVCLIENTS         65532
   #define CALL_SRVCALLS           65531
   #define CALL_SRVSESSIONS        65530
   
   #define CALL_BLOBSHUTDOWN       65529
   #define CALL_BLOBCLIENTS        65528
   #define CALL_BLOBVARS           65527
   
   
 /* RPC types */  /* RPC types */
   
 typedef enum {  typedef enum {
         disable, enable, running, kill,         /* for blob.state */  
         ok, error, no,                          /* for blob reply */          ok, error, no,                          /* for blob reply */
         get, set, unset                         /* for blob request */          get, set, unset                         /* for blob request */
 } cmd_type_t;  } cmd_type_t;
Line 143  struct tagRPCCall { Line 145  struct tagRPCCall {
         uint16_t        call_tag;          uint16_t        call_tag;
         uint16_t        call_argc;          uint16_t        call_argc;
         ait_val_t       call_argv[0];          ait_val_t       call_argv[0];
} __packed;             /* size == 24 bytes */} __packed;                     /* size == 24 bytes */
   
 /* Network BLOB packet - Header */  /* Network BLOB packet - Header */
   
Line 155  struct tagBLOBHdr { Line 157  struct tagBLOBHdr {
         uint32_t        hdr_ret;          uint32_t        hdr_ret;
         uint16_t        hdr_crc;          uint16_t        hdr_crc;
         uint8_t         hdr_pad;          uint8_t         hdr_pad;
} __packed;} __packed;                     /* size == 22 bytes */
   
 /* Network RPC client & server elements */  /* Network RPC client & server elements */
   
Line 168  typedef struct tagRPCFunc { Line 170  typedef struct tagRPCFunc {
         void                    *func_parent;          void                    *func_parent;
         TAILQ_ENTRY(tagRPCFunc) func_node;          TAILQ_ENTRY(tagRPCFunc) func_node;
 } rpc_func_t;  } rpc_func_t;
   #define RPC_FUNC_RETVARS(x)     ((x)->func_vars)
   #define RPC_FUNC_SERVER(x)      ((rpc_srv_t*) (x)->func_parent)
   
   
   /* BLOB register element */
   typedef struct tagBLOB {
           uint32_t                blob_var;       /* BLOB id */
   
           size_t                  blob_len;       /* size of allocated BLOB data */
           void                    *blob_data;     /* mapped BLOB data */
   
           TAILQ_ENTRY(tagBLOB)    blob_node;
   } rpc_blob_t;
   
   
 typedef struct {  typedef struct {
         int             cli_id;         /* slot id */          int             cli_id;         /* slot id */
         int             cli_sock;       /* socket fd */          int             cli_sock;       /* socket fd */
Line 179  typedef struct { Line 194  typedef struct {
         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 */
 } rpc_cli_t;  } rpc_cli_t;
   
   
 /* BLOB registration element! */  
 typedef struct tagBLOB {  
         uint32_t        blob_var;  
   
         size_t          blob_len;       // size of allocated BLOB data  
         void            *blob_data;     // BLOB data  
   
         struct tagBLOB  *blob_next;  
 } rpc_blob_t;  
   
 typedef struct {  typedef struct {
         rpc_sess_t                      srv_session;    /* RPC session registration info */          rpc_sess_t                      srv_session;    /* RPC session registration info */
         int                             srv_netbuf;     /* size of network buffer */          int                             srv_netbuf;     /* size of network buffer */
   
           pthread_t                       srv_tid;        /* RPC exec pthread */
         sched_root_task_t               *srv_root;      /* RPC server scheduler */          sched_root_task_t               *srv_root;      /* RPC server scheduler */
         intptr_t                        srv_kill;       /* Scheduler condition variable */          intptr_t                        srv_kill;       /* Scheduler condition variable */
   
Line 203  typedef struct { Line 208  typedef struct {
         TAILQ_HEAD(, tagRPCFunc)        srv_funcs;      /* RPC functions list */          TAILQ_HEAD(, tagRPCFunc)        srv_funcs;      /* RPC functions list */
   
         struct {          struct {
                cmd_type_t      state;               // BLOB server state: ==0 disable | !=0 enable                pthread_t                       tid;               /* BLOB exec pthread */
                ait_val_t       dir;                sched_root_task_t               *root;          /* BLOB server scheduler */
                 intptr_t                        kill;           /* BLOB server state: ==0 disable | !=0 enable */
   
                rpc_cli_t       server;              // BLOB server socket                ait_val_t                       dir;              /* BLOB states directory */
                rpc_cli_t       *clients;       // connected blob client sockets 
   
                rpc_blob_t      *blobs;          // registered blob variables list                rpc_cli_t                   server;         /* BLOB server socket */
                 array_t                         *clients;       /* connected blob client sockets */
 
                 TAILQ_HEAD(, tagBLOB)                blobs;          /* registered blob variables list */
         }                               srv_blob;          }                               srv_blob;
 } rpc_srv_t;  } rpc_srv_t;
   
Line 218  typedef struct { Line 226  typedef struct {
  * (*rpc_callback_t)() - Callback type definition for RPC call in server process   * (*rpc_callback_t)() - Callback type definition for RPC call in server process
  *   *
  * @arg1 = current execution RPC call function   * @arg1 = current execution RPC call function
 * @arg2 = number of items in input array from call request * @arg2 = RPC packet header
  * @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, array_t *);typedef int (*rpc_callback_t)(rpc_func_t *, struct tagRPCCall *, array_t *);
   
   
// -----------------------------------------------------------------------/* ----------------------------------------------------------------------- */
   
 /* Error support functions */  /* Error support functions */
   
Line 252  inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t Line 260  inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t
  */   */
 inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
 /*  /*
    * rpc_register_srvPing() - Register ping service function
    *
    * @srv = RPC server instance
    * return: -1 error or 0 ok
    */
   inline int rpc_register_srvPing(rpc_srv_t * __restrict srv);
   /*
  * rpc_register_srvServices() - Register internal service functions   * rpc_register_srvServices() - Register internal service functions
  *   *
  * @srv = RPC server instance   * @srv = RPC server instance
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 int rpc_register_srvServices(rpc_srv_t * __restrict srv);  int rpc_register_srvServices(rpc_srv_t * __restrict srv);
   /*
    * rpc_register_blobServices() - Register internal service functions
    *
    * @srv = RPC server instance
    * return: -1 error or 0 ok
    */
   int rpc_register_blobServices(rpc_srv_t * __restrict srv);
   
   
 /* RPC Server side functions */  /* RPC Server side functions */
Line 268  int rpc_register_srvServices(rpc_srv_t * __restrict sr Line 290  int rpc_register_srvServices(rpc_srv_t * __restrict sr
  * @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) * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  * @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
Line 290  void rpc_srv_endServer(rpc_srv_t ** __restrict psrv); Line 312  void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
  * return: -1 error or 0 ok, infinite loop ...   * return: -1 error or 0 ok, infinite loop ...
  */   */
 int rpc_srv_loopServer(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; \#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \
                                                pthread_create(&__tid, NULL, (void*(*)(void*)) \                                                if (!(_srv)->srv_kill) { \
                                                                rpc_srv_loopServer, (_srv)); \                                                        pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
                                                if ((_sync)) \                                                                        rpc_srv_loopServer, (_srv)); \
                                                        pthread_join(__tid, (void**) (_sync)); \                                                        if ((_sync)) \
                                                else \                                                                pthread_join((_srv)->srv_tid, (void**) (_sync)); \
                                                        pthread_detach(__tid); \                                                        else \
                                        } while (0)                                                                pthread_detach((_srv)->srv_tid); \
                                                 } } while (0)
   
 /*  /*
  * rpc_srv_initBLOBServer() - Init & create BLOB Server   * rpc_srv_initBLOBServer() - Init & create BLOB Server
Line 307  int rpc_srv_loopServer(rpc_srv_t * __restrict srv); Line 330  int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
  * @diskDir = Disk place for BLOB file objects   * @diskDir = Disk place for BLOB file objects
  * return: -1 == error or 0 bind and created BLOB server instance   * return: -1 == error or 0 bind and created BLOB server instance
  */   */
int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
 /*  /*
  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources   * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
  *   *
Line 321  void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv) Line 344  void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv)
  * @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_loopBLOB(rpc_srv_t * __restrict srv);int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
#define rpc_srv_execBLOBServer(_srv)    do { assert((_srv)); pthread_t __tid; \#define rpc_srv_execBLOBServer(_srv)    do { assert((_srv)); \
                                                if ((_srv)->srv_blob.state == enable) { \                                                if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \                                                        pthread_create(&(_srv)->srv_blob.tid, NULL, \
                                                                        rpc_srv_loopBLOB, (_srv)); \                                                                        (void*(*)(void*)) \
                                                        pthread_detach(__tid); \                                                                        rpc_srv_loopBLOBServer, (_srv)); \
                                                        (_srv)->srv_blob.state = running; \                                                        pthread_detach((_srv)->srv_blob.tid); \
                                                 } \                                                  } \
                                         } while (0)                                          } while (0)
   
Line 335  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); Line 358  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
  * rpc_srv_registerCall() - Register call to RPC server   * rpc_srv_registerCall() - Register call to RPC server
  *   *
  * @srv = RPC Server instance   * @srv = RPC Server instance
 * @csModule = Module name, if NULL self binary * @tag = Function tag
 * @csFunc = Function name * @funcaddr = Function address
 * @args = Number of return function arguments, use for restriction case! * @args = Number of return function arguments
 * return: -1 error or 0 register ok * return: -1 error, 0 already registered tag or 1 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, unsigned short tag, 
                unsigned short args);                void *funcaddr, 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
 * @csModule = Module name, if NULL self binary * @tag = Function tag
 * @csFunc = Function name 
  * return: -1 error, 0 not found call, 1 unregister ok   * return: -1 error, 0 not found call, 1 unregister ok
  */   */
int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
 /*  /*
 * rpc_srv_getFunc() - Get registered call from RPC server by Name * rpc_srv_getCall()  - Get registered call from RPC server
  *   *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @csModule = Module name, if NULL self binary  
  * @csFunc = Function name  
  * return: NULL not found call, !=NULL return call  
  */  
 rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);  
 /*  
  * rpc_srv_getCall() - Get registered call from RPC server  
  *  
  * @srv = RPC Server instance  
  * @tag = tag for function   * @tag = tag for function
  * return: NULL not found call, !=NULL return call   * return: NULL not found call, !=NULL return call
  */   */
Line 381  int rpc_srv_execCall(rpc_func_t * __restrict call, str Line 394  int rpc_srv_execCall(rpc_func_t * __restrict call, str
   
   
 /*  /*
 * rpc_srv_getVars() - Get variables array for RPC call * rpc_srv_blobCreate() - Create and map blob to memory region and return object
  *   *
  * @call = RPC function call  
  * @vars = Returned variables array, may be NULL  
  * return: -1 error, !=-1 Number of returned variables  
  */  
 inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);  
   
   
 /*  
  * rpc_srv_blobCreate() - Create map blob to memory region and return object  
  *  
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @len = BLOB length object   * @len = BLOB length object
  * return: NULL error or !=NULL allocated BLOB object   * return: NULL error or !=NULL allocated BLOB object
Line 504  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, Line 507  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
                 void ** __restrict data);                  void ** __restrict data);
   
   
 /*  
  * rpc_calcHashes() - Calculate hashes for RPC call  
  *  
  * @func = function  
  * @csModule = Module name, if NULL self binary  
  * @csFunc = Function name  
  * return: -1 error or 0 ok  
  */  
 int rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc);  
   
   
 /* RPC Client side functions */  /* RPC Client side functions */
   
 /*  /*
Line 523  int rpc_calcHashes(rpc_func_t * __restrict func, const Line 515  int rpc_calcHashes(rpc_func_t * __restrict func, const
  * @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)   * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
  * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout  
  * @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(unsigned int ProgID, unsigned int ProcID, int netBuf, rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf, 
                unsigned char Timeout, unsigned short family,  
                 const char *csHost, unsigned short Port);                  const char *csHost, unsigned 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 538  rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns Line 527  rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns
  * @cli = RPC Client session   * @cli = RPC Client session
  * return: none   * return: none
  */   */
void rpc_cli_closeClient(rpc_cli_t * __restrict cli);void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
 /*  /*
  * rpc_cli_execCall() - Execute RPC call   * rpc_cli_execCall() - Execute RPC call
  *   *
  * @cli = RPC Client session   * @cli = RPC Client session
  * @noreply = We not want RPC reply   * @noreply = We not want RPC reply
 * @csModule = Module name, if NULL self binary * @tag = Function tag for execution
 * @csFunc = Function name for execute * @in_vars = IN RPC call array of rpc values, may be NULL
 * @in_vars = IN RPC call array of rpc values * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars()
 * @out_vars = OUT returned array of rpc values, must be free after use with 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, int noreply, const char *csModule, const char *csFunc, int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, 
                 array_t * __restrict in_vars, array_t ** __restrict out_vars);                  array_t * __restrict in_vars, array_t ** __restrict out_vars);
   /*
    * rpc_cli_ping() - Ping RPC server
    *
    * @cli = connected client
    * return: -1 error or !=-1 ping seq id
    */
   inline int rpc_cli_ping(rpc_cli_t *cli);
   
   
 /*  /*
Line 561  int rpc_cli_execCall(rpc_cli_t *cli, int noreply, cons Line 556  int rpc_cli_execCall(rpc_cli_t *cli, int noreply, cons
  * @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 BLOB server established   * return: NULL == error or !=NULL connection to BLOB server established
  */   */
rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
 /*  /*
  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources   * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
  *   *
  * @cli = BLOB Client session   * @cli = BLOB Client session
  * return: none   * return: none
  */   */
void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
   
   
 #endif  #endif
Removed from v.1.8.2.3  
changed lines
  Added in v.1.8.2.20

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