[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.5.2.3 and 1.8.2.4

version 1.5.2.3, 2012/03/12 16:28:09 version 1.8.2.4, 2012/05/15 22:47:10
Line 57  SUCH DAMAGE. Line 57  SUCH DAMAGE.
 #include <sys/limits.h>  #include <sys/limits.h>
 #endif  #endif
 #include <sys/socket.h>  #include <sys/socket.h>
   #include <sys/queue.h>
 #include <aitio.h>  #include <aitio.h>
 #include <aitsched.h>  #include <aitsched.h>
   
   
#define RPC_VERSION             3#define RPC_VERSION             4
 #define RPC_DEFPORT             2611  #define RPC_DEFPORT             2611
   
   /* RPC call request flags */
   
   #define RPC_REPLY               0x0
   #define RPC_NOREPLY             0x1
   
 /* RPC builtin registed calls */  /* RPC builtin registed calls */
   
 #define CALL_BLOBSHUTDOWN       "rpcBLOBServerShutdown"  #define CALL_BLOBSHUTDOWN       "rpcBLOBServerShutdown"
Line 82  SUCH DAMAGE. Line 87  SUCH DAMAGE.
   
 typedef enum {  typedef enum {
         disable, enable, running, kill,         /* for blob.state */          disable, enable, running, kill,         /* for blob.state */
        ok, error,                               /* 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 109  typedef enum { Line 114  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;        uint8_t             sess_process;
} __packed rpc_sess_t;} __packed rpc_sess_t;          /* size == 6 bytes */
   
   
 /* Server managment RPC functions ... */  /* Server managment RPC functions ... */
   
 /* RPC function registration element! */  
 typedef struct tagRPCFunc {  
         uint16_t                func_tag;  
         uint32_t                func_hash;  
         char                    *func_file;  
         char                    *func_name;  
   
         array_t                 *func_vars;  
   
         void                    *func_parent;  
         struct tagRPCFunc       *func_next;  
 } rpc_func_t;  
   
   
 /* Network RPC packet - Client request */  /* Network RPC packet - Client request */
   
 struct tagRPCCall {  struct tagRPCCall {
         rpc_sess_t      call_session;          rpc_sess_t      call_session;
         uint16_t        call_tag;  
         uint32_t        call_hash;  
         uint16_t        call_argc;  
 } __packed;  
   
/* Network RPC packet - Server response */        uint16_t        call_seq;
         uint16_t        call_len;
         uint16_t        call_crc;
   
struct tagRPCRet {        union {
        rpc_sess_t      ret_session;                struct {
        uint16_t    ret_tag;                        uint64_t    flags;
        uint32_t        ret_hash;                }       call_req;
        int32_t         ret_retcode;                struct {
        int32_t         ret_errno;                        int32_t         ret;
        uint16_t        ret_argc;                        int32_t         eno;
} __packed;                }       call_rep;
         };
   
           uint16_t        call_tag;
           uint16_t        call_argc;
           ait_val_t       call_argv[0];
   } __packed;                     /* size == 24 bytes */
   
 /* Network BLOB packet - Header */  /* Network BLOB packet - Header */
   
 struct tagBLOBHdr {  struct tagBLOBHdr {
Line 159  struct tagBLOBHdr { Line 153  struct tagBLOBHdr {
         uint32_t        hdr_var;          uint32_t        hdr_var;
         uint32_t        hdr_len;          uint32_t        hdr_len;
         uint32_t        hdr_ret;          uint32_t        hdr_ret;
           uint16_t        hdr_crc;
           uint8_t         hdr_pad;
 } __packed;  } __packed;
   
 /* Network RPC client & server elements */  /* Network RPC client & server elements */
   
   /* RPC function registration element! */
   typedef struct tagRPCFunc {
           ait_val_t               func_name;
   
           array_t                 *func_vars;
   
           void                    *func_parent;
           TAILQ_ENTRY(tagRPCFunc) func_node;
   } rpc_func_t;
   
   
 typedef struct {  typedef struct {
        io_sockaddr_t   cli_sa;         // host info        int             cli_id;         /* slot id */
        int             cli_sock;       // socket fd        int             cli_sock;       /* socket fd */
        pthread_t      cli_tid;    // TID of thread        io_sockaddr_t   cli_sa;         /* host address */
         ait_val_t      cli_buf;    /* network buffer */
   
        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 184  typedef struct tagBLOB { Line 191  typedef struct tagBLOB {
 } rpc_blob_t;  } 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_numcli;     // maximum concurent client connections        int                             srv_netbuf;     /* size of network buffer */
        int                        srv_netbuf;     // size of network buffer size 
   
        rpc_cli_t              srv_server; // RPC server socket        sched_root_task_t              *srv_root;   /* RPC server scheduler */
        rpc_cli_t              *srv_clients;        // connected rpc client sockets        intptr_t                      srv_kill;   /* Scheduler condition variable */
   
        rpc_func_t                *srv_funcs;      // registered functions list        rpc_cli_t                   srv_server;     /* RPC server socket */
         array_t                         *srv_clients;      /* connected rpc client sockets */
   
        pthread_mutex_t         srv_mtx;        TAILQ_HEAD(, tagRPCFunc)        srv_funcs;  /* RPC functions list */
        cmd_type_t              srv_kill; 
   
         struct {          struct {
                 cmd_type_t      state;          // BLOB server state: ==0 disable | !=0 enable                  cmd_type_t      state;          // BLOB server state: ==0 disable | !=0 enable
                char            *dir;                ait_val_t        dir;
   
                 rpc_cli_t       server;         // BLOB server socket                  rpc_cli_t       server;         // BLOB server socket
                 rpc_cli_t       *clients;       // connected blob client sockets                  rpc_cli_t       *clients;       // connected blob client sockets
   
                 rpc_blob_t      *blobs;         // registered blob variables list                  rpc_blob_t      *blobs;         // registered blob variables list
        }                               srv_blob;
                pthread_mutex_t mtx; 
        }                       srv_blob; 
 
        sched_root_task_t       *srv_sched; 
 } rpc_srv_t;  } rpc_srv_t;
   
   
Line 234  inline const char *rpc_GetError(); Line 236  inline const char *rpc_GetError();
   
   
 /*  /*
 * rpc_chkPktSession() - Check session in RPC packet * rpc_chkPktSession() - Check RPC session
  *   *
  * @p = packet session   * @p = packet session
  * @s = active session   * @s = active session
 * return: -1 error or 0 ok * return: -1, 1, 2, 3 are errors or 0 ok
  */   */
 inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);  inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
 /*  /*
 * rpc_addPktSession() - Add session into RPC packet * rpc_addPktSession() - Prepare session into network format
  *   *
  * @p = packet session   * @p = packet session
 * @s = active session * @s = host session
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 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_srvServices() - Register internal service functions
    *
    * @srv = RPC server instance
    * return: -1 error or 0 ok
    */
   int rpc_register_srvServices(rpc_srv_t * __restrict srv);
   
   
 /* RPC Server side functions */  /* RPC Server side functions */
Line 260  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t Line 269  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t
  * @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, if =0 == BUFSIZ (also meaning max RPC packet)
  * @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(unsigned int regProgID, unsigned char regProcID, 
                int netBuf, u_short family, const char *csHost, u_short Port);                int concurentClients, int netBuf, 
                 const char *csHost, unsigned 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
  *   *
Line 326  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); Line 335  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
  * @hash = hash for function  
  * return: NULL not found call, !=NULL return call   * return: NULL not found call, !=NULL return call
  */   */
inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
 /*  /*
  * rpc_srv_execCall() - Execute registered call from RPC server   * rpc_srv_execCall() - Execute registered call from RPC server
  *   *
Line 373  int rpc_srv_execCall(rpc_func_t * __restrict call, str Line 371  int rpc_srv_execCall(rpc_func_t * __restrict call, str
   
   
 /*  /*
  * rpc_srv_getVars() - Get variables array for RPC call  
  *  
  * @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   * rpc_srv_blobCreate() - Create map blob to memory region and return object
  *   *
  * @srv = RPC Server instance   * @srv = RPC Server instance
Line 492  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va Line 480  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 ** __restrict data);inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
                 void ** __restrict data);
   
   
   
 /* RPC Client side functions */  /* RPC Client side functions */
   
 /*  /*
Line 504  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, Line 492  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
  * @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   * @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, int netBuf, rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf, 
                u_short family, const char *csHost, u_short Port);                unsigned char Timeout, unsigned short family, 
                 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 522  void rpc_cli_closeClient(rpc_cli_t * __restrict cli); Line 512  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
  * @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_vars = IN RPC call array of rpc values   * @in_vars = IN RPC call array of rpc values
  * @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 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, const char *csModule, const char *csFunc, int rpc_cli_execCall(rpc_cli_t *cli, int noreply, 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);
   
   
Removed from v.1.5.2.3  
changed lines
  Added in v.1.8.2.4

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