[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.2 and 1.5.2.3

version 1.5.2.2, 2012/03/12 14:53:07 version 1.5.2.3, 2012/03/12 16:28:09
Line 121  typedef struct { Line 121  typedef struct {
 typedef struct tagRPCFunc {  typedef struct tagRPCFunc {
         uint16_t                func_tag;          uint16_t                func_tag;
         uint32_t                func_hash;          uint32_t                func_hash;
        char                    func_file[MAXPATHLEN];        char                    *func_file;
        char                    func_name[UCHAR_MAX + 1];        char                    *func_name;
   
         array_t                 *func_vars;          array_t                 *func_vars;
   
Line 213  typedef struct { Line 213  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 = number of items in input array from call request
  * @arg3 = input array with values from RPC call execution request   * @arg3 = input array with values from RPC call execution request
Line 233  inline const char *rpc_GetError(); Line 234  inline const char *rpc_GetError();
   
   
 /*  /*
 * rpc_chkPktSession() Check session in RPC packet * rpc_chkPktSession() - Check session in RPC packet
  *
  * @p = packet session   * @p = packet session
  * @s = active session   * @s = active session
  * return: -1 error or 0 ok   * return: -1 error 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() - Add session into RPC packet
  *
  * @p = packet session   * @p = packet session
  * @s = active session   * @s = active session
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
Line 251  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t Line 254  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t
 /* RPC Server side functions */  /* RPC Server side functions */
   
 /*  /*
 * rpc_srv_initServer() Init & create RPC Server * rpc_srv_initServer() - Init & create RPC Server
  *
  * @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
Line 264  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t Line 268  inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t
 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, 
                 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
  *
  * @psrv = RPC Server instance   * @psrv = RPC Server instance
  * return: none   * return: none
  */   */
 void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);  void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
 /*  /*
 * rpc_srv_loopServer() 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 ...
  */   */
Line 285  int rpc_srv_loopServer(rpc_srv_t * __restrict srv); Line 291  int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
                                         } while (0)                                          } while (0)
   
 /*  /*
 * rpc_srv_initBLOBServer() Init & create BLOB Server * rpc_srv_initBLOBServer() - Init & create BLOB Server
  *
  * @srv = RPC server instance   * @srv = RPC server instance
  * @Port = Port for bind server, if Port == 0 default port is selected   * @Port = Port for bind server, if Port == 0 default port is selected
  * @diskDir = Disk place for BLOB file objects   * @diskDir = Disk place for BLOB file objects
Line 293  int rpc_srv_loopServer(rpc_srv_t * __restrict srv); Line 300  int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
  */   */
 int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);  int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_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
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * return: none   * return: none
  */   */
 void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);  void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
 /*  /*
 * rpc_srv_loopBLOB() 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 ...
  */   */
Line 314  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); Line 323  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
                                         } while (0)                                          } while (0)
   
 /*  /*
 * 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   * @csModule = Module name, if NULL self binary
  * @csFunc = Function name   * @csFunc = Function name
Line 324  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv); Line 334  int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
 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 short 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
  * @csModule = Module name, if NULL self binary   * @csModule = Module name, if NULL self binary
  * @csFunc = Function name   * @csFunc = Function name
Line 332  int rpc_srv_registerCall(rpc_srv_t * __restrict srv, c Line 343  int rpc_srv_registerCall(rpc_srv_t * __restrict srv, c
  */   */
 int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);  int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
 /*  /*
 * rpc_srv_getFunc() Get registered call from RPC server by Name * rpc_srv_getFunc() - Get registered call from RPC server by Name
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @csModule = Module name, if NULL self binary   * @csModule = Module name, if NULL self binary
  * @csFunc = Function name   * @csFunc = Function name
Line 340  int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, Line 352  int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv,
  */   */
 rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);  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 * rpc_srv_getCall() - Get registered call from RPC server
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @tag = tag for function   * @tag = tag for function
  * @hash = hash for function   * @hash = hash for function
Line 348  rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv Line 361  rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv
  */   */
 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, uint32_t hash);
 /*  /*
 * 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 calling arguments from RPC client   * @args = IN RPC calling arguments from RPC client
Line 359  int rpc_srv_execCall(rpc_func_t * __restrict call, str Line 373  int rpc_srv_execCall(rpc_func_t * __restrict call, str
   
   
 /*  /*
 * rpc_srv_copyVars() Copy variables for RPC call to new variable array * rpc_srv_getVars() - Get variables array for RPC call
  *
  * @call = RPC function call   * @call = RPC function call
  * @newvars = New allocated variables array, must be free after use  
  * return: -1 error, !=-1 Returned number of copied RPC variables  
  */  
 inline int rpc_srv_copyVars(rpc_func_t * __restrict call, array_t ** __restrict newvars);  
 /*  
  * rpc_srv_getVars() Get variables array for RPC 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
  */   */
Line 375  inline int rpc_srv_getVars(rpc_func_t * __restrict cal Line 383  inline int rpc_srv_getVars(rpc_func_t * __restrict cal
   
   
 /*  /*
 * 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
  * @len = BLOB length object   * @len = BLOB length object
  * return: NULL error or !=NULL allocated BLOB object   * return: NULL error or !=NULL allocated BLOB object
  */   */
 inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);  inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
 /*  /*
 * rpc_srv_blobMap() Map blob to memory region  * rpc_srv_blobMap() - Map blob to memory region 
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @blob = Map to this BLOB element   * @blob = Map to this BLOB element
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
  */   */
 inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);  inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
 /*  /*
 * rpc_srv_blobUnmap() Unmap blob memory region  * rpc_srv_blobUnmap() - Unmap blob memory region 
  *
  * @blob = Mapped BLOB element   * @blob = Mapped BLOB element
  * return: none   * return: none
  */   */
 inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);  inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
 /*  /*
 * rpc_srv_blobFree() Free blob from disk & memory * rpc_srv_blobFree() - Free blob from disk & memory
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @blob = Mapped BLOB element   * @blob = Mapped BLOB element
  * return: -1 error or 0 ok   * return: -1 error or 0 ok
Line 403  inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict  Line 415  inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict 
 inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);  inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
   
 /*  /*
 * rpc_srv_registerBLOB() Register new BLOB to server * rpc_srv_registerBLOB() - Register new BLOB to server
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @len = BLOB length   * @len = BLOB length
  * return: NULL error or new registered BLOB   * return: NULL error or new registered BLOB
  */   */
 rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);  rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
 /*  /*
 * rpc_srv_unregisterBLOB() Unregister BLOB from server * rpc_srv_unregisterBLOB() - Unregister BLOB from server
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @var = BLOB Variable for unregister   * @var = BLOB Variable for unregister
  * return: -1 error, 0 not found call, 1 unregister ok   * return: -1 error, 0 not found call, 1 unregister ok
  */   */
 int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);  int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
 /*  /*
 * rpc_srv_getBLOB() Get registered BLOB  * rpc_srv_getBLOB() - Get registered BLOB 
  *
  * @srv = RPC Server instance   * @srv = RPC Server instance
  * @var = hash for variable   * @var = hash for variable
  * return: NULL not found, !=NULL return blob var   * return: NULL not found, !=NULL return blob var
Line 425  int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, Line 440  int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv,
 inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);  inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
   
 /*  /*
 * rpc_srv_sendBLOB() Send mapped BLOB to client * rpc_srv_sendBLOB() - Send mapped BLOB to client
  *
  * @cli = Client instance   * @cli = Client instance
  * @blob = Mapped BLOB element   * @blob = Mapped BLOB element
  * return: -1 error, 0 ok   * return: -1 error, 0 ok
  */   */
 int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);  int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
 /*  /*
 * rpc_srv_recvBLOB() Receive BLOB from client * rpc_srv_recvBLOB() - Receive BLOB from client
  *
  * @cli = Client instance   * @cli = Client instance
  * @blob = Mapped BLOB element   * @blob = Mapped BLOB element
  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?   * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
Line 442  int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b Line 459  int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b
 /* CLIENT part of functions */  /* CLIENT part of functions */
   
 /*  /*
 * rpc_cli_sendBLOB() Send BLOB to server * rpc_cli_sendBLOB() - Send BLOB to server
  *
  * @cli = Client instance   * @cli = Client instance
  * @var = BLOB variable   * @var = BLOB variable
  * @data = BLOB data   * @data = BLOB data
Line 450  int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b Line 468  int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b
  */   */
 int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
 /*  /*
 * rpc_cli_recvBLOB() Receive BLOB from server * rpc_cli_recvBLOB() - Receive BLOB from server
  *
  * @cli = Client instance   * @cli = Client instance
  * @var = BLOB variable   * @var = BLOB variable
  * @data = BLOB data, must be free after use!   * @data = BLOB data, must be free after use!
Line 458  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v Line 477  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v
  */   */
 int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict 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
  * @var = BLOB variable   * @var = BLOB variable
  * return: -1 error, 0 ok, 1 remote error   * return: -1 error, 0 ok, 1 remote error
  */   */
 int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
 /*  /*
 * rpc_cli_getBLOB() Receive BLOB from server and Delete after that. * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
  *
  * @cli = Client instance   * @cli = Client instance
  * @var = BLOB variable   * @var = BLOB variable
  * @data = BLOB data, must be free after use!   * @data = BLOB data, must be free after use!
Line 478  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, Line 499  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
 /* RPC Client side functions */  /* RPC Client side functions */
   
 /*  /*
 * 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)   * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
Line 490  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, Line 512  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
 rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, int netBuf,   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
  *
  * @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
  * @csModule = Module name, if NULL self binary   * @csModule = Module name, if NULL self binary
  * @csFunc = Function name for execute   * @csFunc = Function name for execute
Line 509  int rpc_cli_execCall(rpc_cli_t *cli, const char *csMod Line 533  int rpc_cli_execCall(rpc_cli_t *cli, const char *csMod
   
   
 /*  /*
 * rpc_cli_openBLOBClient() Connect to BLOB Server * rpc_cli_openBLOBClient() - Connect to BLOB Server
  *
  * @rpccli = RPC Client session   * @rpccli = RPC Client session
  * @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, u_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
  */   */
Removed from v.1.5.2.2  
changed lines
  Added in v.1.5.2.3

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