--- libaitrpc/inc/aitrpc.h 2010/06/28 17:10:39 1.1.1.1.2.14 +++ libaitrpc/inc/aitrpc.h 2011/08/18 15:38:18 1.2.4.1 @@ -3,9 +3,46 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.1.1.1.2.14 2010/06/28 17:10:39 misho Exp $ +* $Id: aitrpc.h,v 1.2.4.1 2011/08/18 15:38:18 misho Exp $ * -*************************************************************************/ +************************************************************************** +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 + +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 + by Michael Pounov . 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 +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 #define __AITRPC_H @@ -15,7 +52,9 @@ #include #include #include +#if !defined(__NetBSD__) #include +#endif #include @@ -61,7 +100,7 @@ typedef struct { union { uint8_t *buffer; int8_t *string; - void *blob; + uint32_t blob; size_t size; off_t offset; time_t datetime; @@ -110,7 +149,9 @@ typedef struct { val->val_type = string; val->val_len = strlen(v) + 1; \ } } while (0) #define RPC_SET_BLOB(vl, v, l) do { rpc_val_t *val = (vl); assert(val); val->val_type = blob; \ - val->val.blob = (void*) v; val->val_len = l; } while (0) + val->val.blob = v; val->val_len = l; } while (0) +#define RPC_SET_BLOB2(vl, b) do { rpc_val_t *val = (vl); assert(val); assert(b); val->val_type = blob; \ + val->val.blob = b->blob_var; val->val_len = b->blob_len; } while (0) #define RPC_SET_SIZE(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = size; val->val.size = v; \ val->val_len = sizeof(size_t); } while (0) #define RPC_SET_OFF(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = offset; val->val.offset = v; \ @@ -151,15 +192,16 @@ typedef struct { } while (0) -#define RPC_CALLBACK_CHK_NUM_ARGS(f, n) do { \ - if (f->func_args != n) { \ - rpc_SetErr(22, "Error:: different number of arguments!\n"); \ +#define RPC_CALLBACK_CHECK_INPUT(x) do { \ + if (!x) { \ + rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ return -1; \ } \ } while (0) -#define RPC_CALLBACK_CHECK_INPUT(f) do { \ - if (!f) { \ - rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \ +#define RPC_CALLBACK_CHK_ARGS(f, n) do { \ + RPC_CALLBACK_CHECK_INPUT(f); \ + if (f && f->func_args != n) { \ + rpc_SetErr(22, "Error:: different number of arguments!\n"); \ return -1; \ } \ } while (0) @@ -217,8 +259,8 @@ struct tagBLOBHdr { rpc_sess_t hdr_session; uint8_t hdr_cmd; uint32_t hdr_var; - uint32_t hdr_seq; uint32_t hdr_len; + uint32_t hdr_ret; } __packed; /* Network RPC client & server elements */ @@ -294,13 +336,14 @@ inline const char *cli_GetError(); * @regProgID = ProgramID for authentication & recognition * @regProcID = ProcessID for authentication & recognition * @concurentClients = Concurent clients at same time to this server - * @family = Family socket type, AF_INET or AF_INET6 - * @csHost = Host name or IP address for bind server, if NULL any address + * @sockType = Socket type, like SOCK_STREAM, SOCK_DGRAM or SOCK_RAW + * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL + * @csHost = Host name or address for bind server, if NULL any address * @Port = Port for bind server, if Port == 0 default port is selected * 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, - u_short family, const char *csHost, u_short Port); + int sockType, u_short family, const char *csHost, u_short Port); /* * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources * @srv = RPC Server instance @@ -335,19 +378,11 @@ void rpc_srv_endBLOBServer(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 * @srv = RPC Server instance * @csModule = Module name, if NULL self binary * @csFunc = Function name - * @args = Number of function arguments + * @args = Number of return function arguments, use for restriction case! * return: -1 error or 0 register ok */ int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, @@ -464,7 +499,7 @@ inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv * rpc_srv_registerBLOB() Register new BLOB to server * @srv = RPC Server instance * @len = BLOB length - * return: -1 error or 0 register ok + * return: NULL error or new registered BLOB */ rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len); /* @@ -474,6 +509,13 @@ rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restric * return: -1 error, 0 not found call, 1 unregister ok */ 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 @@ -503,9 +545,25 @@ int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, rpc_v * @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? + * return: -1 error, 0 ok, 1 remote error */ 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 */