version 1.1.1.1.2.18, 2010/07/08 07:16:36
|
version 1.3, 2011/08/29 22:37:06
|
Line 5
|
Line 5
|
* $Author$ |
* $Author$ |
* $Id$ |
* $Id$ |
* |
* |
*************************************************************************/ | ************************************************************************** |
| The ELWIX and AITNET software is distributed under the following |
| terms: |
| |
| All of the documentation and software included in the ELWIX and AITNET |
| Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org> |
| |
| Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
| by Michael Pounov <misho@elwix.org>. All rights reserved. |
| |
| Redistribution and use in source and binary forms, with or without |
| modification, are permitted provided that the following conditions |
| are met: |
| 1. Redistributions of source code must retain the above copyright |
| notice, this list of conditions and the following disclaimer. |
| 2. Redistributions in binary form must reproduce the above copyright |
| notice, this list of conditions and the following disclaimer in the |
| documentation and/or other materials provided with the distribution. |
| 3. All advertising materials mentioning features or use of this software |
| must display the following acknowledgement: |
| This product includes software developed by Michael Pounov <misho@elwix.org> |
| ELWIX - Embedded LightWeight unIX and its contributors. |
| 4. Neither the name of AITNET nor the names of its contributors |
| may be used to endorse or promote products derived from this software |
| without specific prior written permission. |
| |
| THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND |
| ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| SUCH DAMAGE. |
| */ |
#ifndef __AITRPC_H |
#ifndef __AITRPC_H |
#define __AITRPC_H |
#define __AITRPC_H |
|
|
Line 15
|
Line 52
|
#include <string.h> |
#include <string.h> |
#include <sys/types.h> |
#include <sys/types.h> |
#include <sys/param.h> |
#include <sys/param.h> |
|
#if !defined(__NetBSD__) |
#include <sys/limits.h> |
#include <sys/limits.h> |
|
#endif |
#include <sys/socket.h> |
#include <sys/socket.h> |
|
|
|
|
Line 48 typedef enum {
|
Line 87 typedef enum {
|
} rpc_type_t; |
} rpc_type_t; |
|
|
typedef enum { |
typedef enum { |
disable, enable, // for blob.state | disable, enable, 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 153 typedef struct {
|
Line 192 typedef struct {
|
} while (0) |
} while (0) |
|
|
|
|
#define RPC_CALLBACK_CHK_RETARGS(f, n) do { \ | #define RPC_CALLBACK_CHECK_INPUT(x) do { \ |
if (f->func_args != n) { \ | if (!x) { \ |
rpc_SetErr(22, "Error:: different number of arguments!\n"); \ | rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ |
return -1; \ |
return -1; \ |
} \ |
} \ |
} while (0) |
} while (0) |
#define RPC_CALLBACK_CHECK_INPUT(f) do { \ | #define RPC_CALLBACK_CHK_ARGS(f, n) do { \ |
if (!f) { \ | RPC_CALLBACK_CHECK_INPUT(f); \ |
rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ | if (f && f->func_args != n) { \ |
| rpc_SetErr(22, "Error:: different number of arguments!\n"); \ |
return -1; \ |
return -1; \ |
} \ |
} \ |
} while (0) |
} while (0) |
Line 186 typedef struct tagRPCFunc {
|
Line 226 typedef struct tagRPCFunc {
|
int8_t func_name[UCHAR_MAX + 1]; |
int8_t func_name[UCHAR_MAX + 1]; |
|
|
int8_t func_args; |
int8_t func_args; |
rpc_val_t *func_vals; | rpc_val_t *func_vars; |
|
|
void *func_parent; |
void *func_parent; |
struct tagRPCFunc *func_next; |
struct tagRPCFunc *func_next; |
Line 219 struct tagBLOBHdr {
|
Line 259 struct tagBLOBHdr {
|
rpc_sess_t hdr_session; |
rpc_sess_t hdr_session; |
uint8_t hdr_cmd; |
uint8_t hdr_cmd; |
uint32_t hdr_var; |
uint32_t hdr_var; |
uint32_t hdr_seq; |
|
uint32_t hdr_len; |
uint32_t hdr_len; |
|
uint32_t hdr_ret; |
} __packed; |
} __packed; |
|
|
/* Network RPC client & server elements */ |
/* Network RPC client & server elements */ |
|
|
typedef struct { |
typedef struct { |
struct sockaddr cli_sa; // host info |
struct sockaddr cli_sa; // host info |
int cli_sock; // socket | int cli_sock; // socket fd |
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 |
Line 254 typedef struct {
|
Line 294 typedef struct {
|
rpc_func_t *srv_funcs; // registered functions list |
rpc_func_t *srv_funcs; // registered functions list |
|
|
pthread_mutex_t srv_mtx; |
pthread_mutex_t srv_mtx; |
|
cmd_type_t srv_kill; |
|
|
struct { |
struct { |
int state; // BLOB server state: ==0 disable | !=0 enable | cmd_type_t state; // BLOB server state: ==0 disable | !=0 enable |
char dir[UCHAR_MAX + 1]; |
char dir[UCHAR_MAX + 1]; |
|
|
rpc_cli_t server; // BLOB server socket |
rpc_cli_t server; // BLOB server socket |
Line 283 typedef int (*rpc_callback_t)(rpc_func_t *, int, rpc_v
|
Line 324 typedef int (*rpc_callback_t)(rpc_func_t *, int, rpc_v
|
|
|
/* Error support functions */ |
/* Error support functions */ |
|
|
// cli_GetErrno() Get error code of last operation | // rpc_GetErrno() Get error code of last operation |
inline int cli_GetErrno(); | inline int rpc_GetErrno(); |
// cli_GetError() Get error text of last operation | // rpc_GetError() Get error text of last operation |
inline const char *cli_GetError(); | inline const char *rpc_GetError(); |
|
|
|
|
/* RPC Server side functions */ |
/* RPC Server side functions */ |
Line 296 inline const char *cli_GetError();
|
Line 337 inline const char *cli_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 |
* @family = Family socket type, AF_INET or AF_INET6 | * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL |
* @csHost = Host name or IP 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 318 int rpc_srv_execServer(rpc_srv_t * __restrict srv);
|
Line 359 int rpc_srv_execServer(rpc_srv_t * __restrict srv);
|
|
|
/* |
/* |
* rpc_srv_initBLOBServer() Init & create BLOB Server |
* rpc_srv_initBLOBServer() Init & create BLOB Server |
|
* @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 |
* return: -1 == error or 0 bind and created BLOB server instance |
* return: -1 == error or 0 bind and created BLOB server instance |
Line 337 void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv)
|
Line 379 void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv)
|
int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv); |
int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv); |
|
|
/* |
/* |
* rpc_srv_getBLOB() Get registered BLOB |
|
* @srv = RPC Server instance |
|
* @var = hash for variable |
|
* return: NULL not found, !=NULL return blob var |
|
*/ |
|
inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var); |
|
|
|
/* |
|
* 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 |
Line 390 int rpc_srv_execCall(rpc_func_t * __restrict call, str
|
Line 424 int rpc_srv_execCall(rpc_func_t * __restrict call, str
|
|
|
|
|
/* |
/* |
* rpc_srv_retValsCall() Declare return variables for RPC call and zeroed values | * rpc_srv_returnVars() Init return variables for RPC call and zeroed values |
(for safe handling return values, use this!) |
(for safe handling return values, use this!) |
* @call = RPC function call |
* @call = RPC function call |
* @return_vals = Number of return variables | * @varnum = Number of return variables |
* return: NULL error, !=NULL array with return values for RPC call with return_vals items | * return: NULL error, !=NULL array with return values for RPC call with varnum items |
*/ |
*/ |
inline rpc_val_t *rpc_srv_retValsCall(rpc_func_t * __restrict call, int return_vals); | inline rpc_val_t *rpc_srv_returnVars(rpc_func_t * __restrict call, int varnum); |
/* |
/* |
* rpc_srv_declValsCall() Declare return variables for RPC call, | * rpc_srv_allocVars() Allocate array for call variables, |
if already allocated memory for RPC call return values | if already allocated memory for RPC call reallocate used space |
function reallocate used space with return_vals count elements | |
* @call = RPC function call |
* @call = RPC function call |
* @return_vals = Number of return variables | * @varnum = Number of variables, if ==0 free previous allocated variables |
* return: -1 error, !=-1 ok | * return: -1 error, !=-1 return varnum value |
*/ |
*/ |
inline int rpc_srv_declValsCall(rpc_func_t * __restrict call, int return_vals); | 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_freeValsCall() Free return variables for RPC call | * rpc_srv_zeroVars() Clean values from variables of RPC call |
* @call = RPC function call |
* @call = RPC function call |
* return: none | * return: -1 error, !=-1 Returned number of cleaned RPC variables |
*/ |
*/ |
inline void rpc_srv_freeValsCall(rpc_func_t * __restrict call); | inline int rpc_srv_zeroVars(rpc_func_t * __restrict call); |
/* |
/* |
* rpc_srv_copyValsCall() Copy return variables for RPC call to new variable | * rpc_srv_copyVars() Copy variables for RPC call to new variable array |
* @call = RPC function call |
* @call = RPC function call |
* @newvals = 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_copyValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvals); | inline int rpc_srv_copyVars(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvars); |
/* |
/* |
* rpc_srv_zeroValsCall() Clean values from return variables of RPC call | * rpc_srv_getVars() Get variables array for RPC call |
* @call = RPC function call |
* @call = RPC function call |
* return: -1 error, !=-1 Returned number of cleaned RPC variables | * @vars = Returned variables array, may be NULL |
*/ | |
inline int rpc_srv_zeroValsCall(rpc_func_t * __restrict call); | |
/* | |
* rpc_srv_getValsCall() Get return variables for RPC call | |
* @call = RPC function call | |
* @vals = Returned variables, may be NULL | |
* return: -1 error, !=-1 Number of returned variables |
* return: -1 error, !=-1 Number of returned variables |
*/ |
*/ |
inline int rpc_srv_getValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict vals); | inline int rpc_srv_getVars(rpc_func_t * __restrict call, rpc_val_t ** __restrict vars); |
|
|
|
|
/* |
/* |
Line 476 rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restric
|
Line 504 rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restric
|
* 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 |
|
* @srv = RPC Server instance |
|
* @var = hash for variable |
|
* return: NULL not found, !=NULL return blob 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 |
Line 508 int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, rpc_v
|
Line 543 int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, rpc_v
|
* 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, rpc_val_t * __restrict var, void ** data); |
int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void ** data); |
|
/* |
|
* rpc_cli_delBLOB() Delete BLOB from server |
|
* @cli = Client instance |
|
* @var = BLOB variable |
|
* return: -1 error, 0 ok, 1 remote error |
|
*/ |
|
int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var); |
|
/* |
|
* rpc_cli_getBLOB() Receive BLOB from server and Delete after that. |
|
* @cli = Client instance |
|
* @var = BLOB variable |
|
* @data = BLOB data, must be free after use! |
|
* return: -1 error, 0 ok, >0 remote error |
|
*/ |
|
inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void ** data); |
|
|
|
|
|
|
/* RPC Client side functions */ |
/* RPC Client side functions */ |
|
|
/* |
/* |
Line 521 int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, rpc_v
|
Line 572 int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, rpc_v
|
* @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, u_short family, | rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, |
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 |
Line 535 void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
|
Line 586 void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
|
* @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_argc = IN count of arguments |
* @in_vals = IN RPC call array of rpc values | * @in_vars = IN RPC call array of rpc values |
* @out_argc = OUT returned count of arguments |
* @out_argc = OUT returned count of arguments |
* @out_vals = OUT returned array of rpc values, must be free after use (see 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, int in_argc, |
rpc_val_t * __restrict in_vals, int *out_argc, rpc_val_t ** __restrict out_vals); | rpc_val_t * __restrict in_vars, int *out_argc, rpc_val_t ** __restrict out_vars); |
/* |
/* |
* rpc_cli_freeVals() Free rpc_val_t array returned from RPC call |
* rpc_cli_freeVals() Free rpc_val_t array returned from RPC call |
* @args = Number of arguments in array |
* @args = Number of arguments in array |
* @vals = Value elements | * @vars = Value elements |
* return: none |
* return: none |
*/ |
*/ |
inline void rpc_cli_freeVals(int args, rpc_val_t *vals); | inline void rpc_cli_freeVals(int args, rpc_val_t *vars); |
|
|
|
|
/* |
/* |