--- libaitrpc/inc/aitrpc.h 2013/04/02 15:50:14 1.14 +++ libaitrpc/inc/aitrpc.h 2014/11/17 23:51:26 1.24.2.3 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitrpc.h,v 1.14 2013/04/02 15:50:14 misho Exp $ +* $Id: aitrpc.h,v 1.24.2.3 2014/11/17 23:51:26 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -12,7 +12,7 @@ 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, 2012, 2013 +Copyright 2004 - 2014 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -62,7 +62,7 @@ SUCH DAMAGE. #include -#define RPC_VERSION 6 +#define RPC_VERSION 7 #define RPC_DEFPORT 2611 /* RPC call request flags */ @@ -85,6 +85,8 @@ SUCH DAMAGE. #define CALL_BLOBCLIENTS 65528 #define CALL_BLOBVARS 65527 +/* RPC signals */ +#define SIGFBLOB 54 /* RPC types */ @@ -125,8 +127,7 @@ typedef struct { struct tagRPCCall { rpc_sess_t call_session; - uint16_t call_seq; - uint16_t call_len; + uint32_t call_len; uint16_t call_crc; union { @@ -143,7 +144,8 @@ struct tagRPCCall { uint16_t call_argc; ait_val_t call_argv[0]; } __packed; /* size == 20 bytes */ -#define RPC_CHK_NOREPLY(x) ((x)->call_req.flags & RPC_NOREPLY) +#define RPC_CHK_NOREPLY(x) (ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY) +#define RPC_SET_ERRNO(x, _v) ((x)->call_rep.eno = htonl((_v))) /* Network BLOB packet - Header */ @@ -245,25 +247,59 @@ typedef struct { */ typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *); +#define RPC_CALL_DEFINE(x) int (x)(rpc_cli_t*, struct tagRPCCall*, array_t*) +#define RPC_CALL_ARGS(arg1, arg2, arg3) rpc_cli_t* arg1, struct tagRPCCall* arg2, array_t* arg3 +#define RPC_CALL_STDARGS RPC_CALL_ARGS(cli, rpc, iv) + /* ----------------------------------------------------------------------- */ /* Error support functions */ // rpc_GetErrno() Get error code of last operation -inline int rpc_GetErrno(); +int rpc_GetErrno(); // rpc_GetError() Get error text of last operation -inline const char *rpc_GetError(); +const char *rpc_GetError(); +// rpc_SetErr() Set error to variables for internal use!!! +void rpc_SetErr(int eno, char *estr, ...); + /* + * rpc_Read() - RPC read operation + * + * @sock = socket + * @type = type of socket + * @flags = receive flags + * @sa = check client address, if you use udp protocol + * @buf = buffer + * @blen = buffer length + * return: -1 error, 0 EOF or or >0 readed bytes into buffer + */ +ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa, + unsigned char * __restrict buf, size_t blen); +/* + * rpc_Write() - RPC write operation + * + * @sock = socket + * @type = type of socket + * @flags = send flags + * @sa = send to client address, if you use udp protocol + * @buf = buffer + * @blen = buffer length + * return: -1 error, 0 EOF or >0 written bytes into buffer + */ +ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa, + unsigned char * __restrict buf, size_t blen); + +/* * rpc_chkPktSession() - Check RPC session * * @p = packet session * @s = active session * return: -1, 1, 2, 3 are errors or 0 ok */ -inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s); +int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s); /* * rpc_addPktSession() - Prepare session into network format * @@ -271,14 +307,14 @@ inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t * @s = host session * return: -1 error or 0 ok */ -inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s); +int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s); /* * rpc_register_srvPing() - Register ping service function * * @srv = RPC server instance * return: -1 error or 0 ok */ -inline int rpc_register_srvPing(rpc_srv_t * __restrict srv); +int rpc_register_srvPing(rpc_srv_t * __restrict srv); /* * rpc_register_srvServices() - Register internal service functions * @@ -316,7 +352,7 @@ rpc_srv_t *rpc_srv_initServer(unsigned char InstID, in * @psrv = RPC Server instance * return: none */ -inline 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 * @@ -333,6 +369,7 @@ int rpc_srv_loopServer(rpc_srv_t * __restrict srv); else \ pthread_detach((_srv)->srv_tid); \ } } while (0) +#define rpc_srv_killServer(_srv) (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1) /* * rpc_srv_initBLOBServer() - Init & create BLOB Server @@ -349,7 +386,7 @@ int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, * @srv = RPC Server instance * return: none */ -inline 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 * @@ -367,6 +404,26 @@ int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv) } while (0) /* + * rpc_srv_initServer2() - Init & create layer2 RPC Server + * + * @InstID = Instance for authentication & recognition + * @concurentClients = Concurent clients at same time to this server + * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) + * @csIface = Interface name for bind server, if NULL first interface on host + * return: NULL == error or !=NULL bind and created RPC server instance + */ +rpc_srv_t *rpc_srv_initServer2(u_char InstID, int concurentClients, int netBuf, + const char *csIface); +#define rpc_srv_endServer2(x) rpc_srv_endServer((x)) +/* + * rpc_srv_loopServer2() - Execute Main layer2 server loop and wait for clients requests + * + * @srv = RPC Server instance + * return: -1 error or 0 ok, infinite loop ... + */ +int rpc_srv_loopServer2(rpc_srv_t * __restrict srv); + +/* * rpc_srv_registerCall() - Register call to RPC server * * @srv = RPC Server instance @@ -390,7 +447,7 @@ int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, * @tag = tag for function * return: NULL not found call, !=NULL return call */ -inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag); +rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag); /* * rpc_srv_execCall() Execute registered call from RPC server * @@ -409,9 +466,10 @@ int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc * * @srv = RPC Server instance * @len = BLOB length object + * @tout = BLOB live timeout in seconds * return: NULL error or !=NULL allocated BLOB object */ -inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len); +rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout); /* * rpc_srv_blobMap() - Map blob to memory region * @@ -419,14 +477,14 @@ inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __re * @blob = Map to this BLOB element * return: -1 error or 0 ok */ -inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob); +int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob); /* * rpc_srv_blobUnmap() - Unmap blob memory region * * @blob = Mapped BLOB element * return: none */ -inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob); +void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob); /* * rpc_srv_blobFree() - Free blob from disk & memory * @@ -434,16 +492,17 @@ inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict * @blob = Mapped BLOB element * return: -1 error or 0 ok */ -inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob); +int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob); /* * rpc_srv_registerBLOB() - Register new BLOB to server * * @srv = RPC Server instance * @len = BLOB length + * @tout = BLOB live timeout in seconds * 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, int tout); /* * rpc_srv_unregisterBLOB() - Unregister BLOB from server * @@ -459,7 +518,7 @@ int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, * @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_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var); /* * rpc_srv_sendBLOB() - Send mapped BLOB to client @@ -486,9 +545,11 @@ int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b * @cli = Client instance * @var = BLOB variable * @data = BLOB data + * @tout = BLOB live on server timeout in seconds, if =0 default timeout * return: -1 error, 0 ok, 1 remote error */ -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, int tout); /* * rpc_cli_recvBLOB() - Receive BLOB from server * @@ -514,7 +575,7 @@ int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va * @data = BLOB data, must be e_free after use! * return: -1 error, 0 ok, >0 remote error */ -inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, +int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data); @@ -533,6 +594,13 @@ inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, const char *csHost, unsigned short Port, int proto); /* + * rpc_cli_reconnectClient() - Reconnecting client to RPC server + * + * @cli = RPC Client session + * return: -1 error or 0 ok + */ +int rpc_cli_reconnectClient(rpc_cli_t * __restrict cli); +/* * rpc_cli_closeClient() - Close connection to RPC server and free resources * * @cli = RPC Client session @@ -547,7 +615,7 @@ void rpc_cli_closeClient(rpc_cli_t ** __restrict cli); * @sa = Server address * @pkt = RPC packet * @len = Length of packet - * return: -1 error or !=-1 sended bytes + * return: -1 error, 0 EOF or >0 sended bytes */ int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt, int len); @@ -558,7 +626,7 @@ int rpc_pkt_Send(int sock, int type, sockaddr_t * __re * @type = Type of socket * @sa = Server address * @pkt = RPC packet - * return: -1 error or !=-1 sended bytes + * return: -1 error, 0 EOF or >0 received bytes */ int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, ait_val_t * __restrict pkt); @@ -579,7 +647,7 @@ int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_se * rpc_pkt_Replay() - Decode RPC Replay packet * * @pkt = Packet buffer - * @sess = RPC session info + * @sess = RPC session info, if =NULL don't check session * @tag = Function tag * @vars = Function argument array of values, may be NULL * @nocrc = Without CRC calculation @@ -595,7 +663,7 @@ int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_ses * @tag = Function tag for execution * @in_vars = IN function argument array of values, may be NULL * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars() - * return: -1 error or != -1 ok result + * return: -1 error, 0 ok result or 1 closed rpc connection */ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, array_t * __restrict in_vars, array_t ** __restrict out_vars); @@ -605,14 +673,14 @@ int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsi * @out_vars = Returned array with variables from RPC call * return: none */ -inline void rpc_cli_freeCall(array_t ** __restrict out_vars); +void rpc_cli_freeCall(array_t ** __restrict out_vars); /* * rpc_cli_ping() - Ping RPC server * * @cli = connected client * return: -1 error or !=-1 ping seq id */ -inline int rpc_cli_ping(rpc_cli_t *cli); +int rpc_cli_ping(rpc_cli_t *cli); /*