--- libaitrpc/inc/aitrpc.h 2010/06/24 11:01:46 1.1.1.1.2.10 +++ libaitrpc/inc/aitrpc.h 2010/06/28 17:10:39 1.1.1.1.2.14 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.1.1.1.2.10 2010/06/24 11:01:46 misho Exp $ +* $Id: aitrpc.h,v 1.1.1.1.2.14 2010/06/28 17:10:39 misho Exp $ * *************************************************************************/ #ifndef __AITRPC_H @@ -28,6 +28,7 @@ #define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown" #define CALL_BLOBCLIENTS "rpcBLOBServerClients" #define CALL_BLOBVARS "rpcBLOBServerVars" +#define CALL_BLOBSTATE "rpcBLOBServerState" #define CALL_SRVSHUTDOWN "rpcServerShutdown" #define CALL_SRVCLIENTS "rpcServerClients" @@ -156,8 +157,8 @@ typedef struct { return -1; \ } \ } while (0) -#define RPC_CALLBACK_CHECK_INPUT(s, f) do { \ - if (!s || !f) { \ +#define RPC_CALLBACK_CHECK_INPUT(f) do { \ + if (!f) { \ rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ return -1; \ } \ @@ -185,6 +186,7 @@ typedef struct tagRPCFunc { int8_t func_args; rpc_val_t *func_vals; + void *func_parent; struct tagRPCFunc *func_next; } rpc_func_t; @@ -265,7 +267,14 @@ typedef struct { } rpc_srv_t; -typedef int (*rpc_callback_t)(void * const, rpc_func_t *, int, rpc_val_t *); +/* + * (*rpc_callback_t)() Callback type definition for RPC call in server process + * @arg1 = current execution RPC call function + * @arg2 = number of items in input array from call request + * @arg3 = input array with values from RPC call execution request + * return: -1 error or >-1 success execution + */ +typedef int (*rpc_callback_t)(rpc_func_t *, int, rpc_val_t *); // ----------------------------------------------------------------------- @@ -369,20 +378,29 @@ 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); /* * rpc_srv_execCall() Execute registered call from RPC server - * @data = RPC const data * @call = Register RPC call * @rpc = IN RPC call structure * @args = IN RPC call array of rpc values * return: -1 error, !=-1 ok */ -int rpc_srv_execCall(void * const data, rpc_func_t * __restrict call, - struct tagRPCCall * __restrict rpc, rpc_val_t * __restrict args); +int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, + rpc_val_t * __restrict args); /* - * rpc_srv_declValsCall() Declare return variables for RPC call + * rpc_srv_retValsCall() Declare return variables for RPC call and zeroed values + (for safe handling return values, use this!) * @call = RPC function call * @return_vals = Number of return variables + * return: NULL error, !=NULL array with return values for RPC call with return_vals items + */ +inline rpc_val_t *rpc_srv_retValsCall(rpc_func_t * __restrict call, int return_vals); +/* + * rpc_srv_declValsCall() Declare return variables for RPC call, + if already allocated memory for RPC call return values + function reallocate used space with return_vals count elements + * @call = RPC function call + * @return_vals = Number of return variables * return: -1 error, !=-1 ok */ inline int rpc_srv_declValsCall(rpc_func_t * __restrict call, int return_vals); @@ -400,11 +418,11 @@ inline void rpc_srv_freeValsCall(rpc_func_t * __restri */ inline int rpc_srv_copyValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvals); /* - * rpc_srv_delValsCall() Clean values from return variables of RPC call + * rpc_srv_zeroValsCall() Clean values from return variables of RPC call * @call = RPC function call * return: -1 error, !=-1 Returned number of cleaned RPC variables */ -inline int rpc_srv_delValsCall(rpc_func_t * __restrict call); +inline int rpc_srv_zeroValsCall(rpc_func_t * __restrict call); /* * rpc_srv_getValsCall() Get return variables for RPC call * @call = RPC function call @@ -472,7 +490,24 @@ 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); +/* + * rpc_cli_sendBLOB() Send BLOB to server + * @cli = Client instance + * @var = BLOB variable + * @data = BLOB data + * return: -1 error, 0 ok, 1 remote error + */ +int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void * __restrict data); +/* + * rpc_cli_recvBLOB() Receive BLOB from server + * @cli = Client instance + * @var = BLOB variable + * @data = BLOB data, must be free after use! + * return: -1 error, 0 ok, >0 unreceived data from server, may be error? + */ +int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void ** data); + /* RPC Client side functions */ /* @@ -512,6 +547,21 @@ int rpc_cli_execCall(rpc_cli_t *cli, const char *csMod * return: none */ inline void rpc_cli_freeVals(int args, rpc_val_t *vals); + + +/* + * rpc_cli_openBLOBClient() Connect to BLOB Server + * @rpccli = RPC Client session + * @Port = Port for bind server, if Port == 0 default port is selected + * 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_closeBLOBClient() Close connection to BLOB server and free resources + * @cli = BLOB Client session + * return: none + */ +void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli); #endif