version 1.15.2.1, 2013/07/15 13:53:09
|
version 1.25.2.5, 2015/01/21 00:37:03
|
Line 12 terms:
|
Line 12 terms:
|
All of the documentation and software included in the ELWIX and AITNET |
All of the documentation and software included in the ELWIX and AITNET |
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org> |
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org> |
|
|
Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 | Copyright 2004 - 2015 |
by Michael Pounov <misho@elwix.org>. All rights reserved. |
by Michael Pounov <misho@elwix.org>. All rights reserved. |
|
|
Redistribution and use in source and binary forms, with or without |
Redistribution and use in source and binary forms, with or without |
Line 62 SUCH DAMAGE.
|
Line 62 SUCH DAMAGE.
|
#include <aitsched.h> |
#include <aitsched.h> |
|
|
|
|
#define RPC_VERSION 6 | #define RPC_VERSION 8 |
#define RPC_DEFPORT 2611 |
#define RPC_DEFPORT 2611 |
|
|
|
/* Additional ELWIX RPC supporting protocols */ |
|
#ifndef SOCK_STREAM |
|
#define SOCK_STREAM 1 /* stream socket */ |
|
#endif |
|
#ifndef SOCK_DGRAM |
|
#define SOCK_DGRAM 2 /* datagram socket */ |
|
#endif |
|
#ifndef SOCK_RAW |
|
#define SOCK_RAW 3 /* raw-protocol interface */ |
|
#endif |
|
#define SOCK_BPF 4 /* ethernet interface */ |
|
#define SOCK_EXT 5 /* bi-directional pipe interface */ |
|
|
/* RPC call request flags */ |
/* RPC call request flags */ |
|
|
#define RPC_REPLY 0x0 |
#define RPC_REPLY 0x0 |
#define RPC_NOREPLY 0x1 |
#define RPC_NOREPLY 0x1 |
|
|
|
/* RPC call I/O direction */ |
|
|
|
#define RPC_REQ 0x0 |
|
#define RPC_ACK 0x1 |
|
|
/* RPC builtin registed calls */ |
/* RPC builtin registed calls */ |
|
|
#define CALL_TAG_MAX 65535 |
#define CALL_TAG_MAX 65535 |
Line 85 SUCH DAMAGE.
|
Line 103 SUCH DAMAGE.
|
#define CALL_BLOBCLIENTS 65528 |
#define CALL_BLOBCLIENTS 65528 |
#define CALL_BLOBVARS 65527 |
#define CALL_BLOBVARS 65527 |
|
|
|
/* RPC signals */ |
|
#define SIGFBLOB 54 |
|
|
/* RPC types */ |
/* RPC types */ |
|
|
Line 125 typedef struct {
|
Line 145 typedef struct {
|
struct tagRPCCall { |
struct tagRPCCall { |
rpc_sess_t call_session; |
rpc_sess_t call_session; |
|
|
uint16_t call_seq; | uint32_t call_len; |
uint16_t call_len; | |
uint16_t call_crc; |
uint16_t call_crc; |
|
|
union { |
union { |
Line 140 struct tagRPCCall {
|
Line 159 struct tagRPCCall {
|
}; |
}; |
|
|
uint16_t call_tag; |
uint16_t call_tag; |
uint16_t call_argc; | uint8_t call_io; |
| uint8_t call_argc; |
ait_val_t call_argv[0]; |
ait_val_t call_argv[0]; |
} __packed; /* size == 20 bytes */ |
} __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 */ |
/* Network BLOB packet - Header */ |
|
|
Line 245 typedef struct {
|
Line 266 typedef struct {
|
*/ |
*/ |
typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *); |
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 */ |
/* Error support functions */ |
Line 254 typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagR
|
Line 279 typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagR
|
int rpc_GetErrno(); |
int rpc_GetErrno(); |
// rpc_GetError() Get error text of last operation |
// rpc_GetError() Get error text of last operation |
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 |
* rpc_chkPktSession() - Check RPC session |
* |
* |
* @p = packet session |
* @p = packet session |
Line 324 void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
|
Line 379 void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
|
* return: -1 error or 0 ok, infinite loop ... |
* return: -1 error or 0 ok, infinite loop ... |
*/ |
*/ |
int rpc_srv_loopServer(rpc_srv_t * __restrict srv); |
int rpc_srv_loopServer(rpc_srv_t * __restrict srv); |
#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \ | #define rpc_srv_execServer(_srv, _sync) \ |
if (!(_srv)->srv_kill) { \ | do { assert((_srv)); \ |
pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \ | if (!(_srv)->srv_kill) { \ |
rpc_srv_loopServer, (_srv)); \ | pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \ |
if ((_sync)) \ | rpc_srv_loopServer, (_srv)); \ |
pthread_join((_srv)->srv_tid, (void**) (_sync)); \ | if ((_sync)) \ |
else \ | pthread_join((_srv)->srv_tid, (void**) (_sync)); \ |
pthread_detach((_srv)->srv_tid); \ | else \ |
} } while (0) | 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 |
* rpc_srv_initBLOBServer() - Init & create BLOB Server |
Line 357 void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv)
|
Line 415 void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv)
|
* return: -1 error or 0 ok, infinite loop ... |
* return: -1 error or 0 ok, infinite loop ... |
*/ |
*/ |
int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv); |
int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv); |
#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \ | #define rpc_srv_execBLOBServer(_srv) \ |
if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \ | do { assert((_srv)); \ |
pthread_create(&(_srv)->srv_blob.tid, NULL, \ | if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \ |
(void*(*)(void*)) \ | pthread_create(&(_srv)->srv_blob.tid, NULL, \ |
rpc_srv_loopBLOBServer, (_srv)); \ | (void*(*)(void*)) rpc_srv_loopBLOBServer, (_srv)); \ |
pthread_detach((_srv)->srv_blob.tid); \ | pthread_detach((_srv)->srv_blob.tid); \ |
} \ | } \ |
} while (0) | } 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); |
|
|
|
/* |
|
* rpc_srv_initServerExt() - Init & create pipe RPC Server |
|
* |
|
* @InstID = Instance for authentication & recognition |
|
* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) |
|
* @fd = File descriptor |
|
* return: NULL == error or !=NULL bind and created RPC server instance |
|
*/ |
|
rpc_srv_t *rpc_srv_initServerExt(u_char InstID, int netBuf, int fd); |
|
|
|
/* |
* rpc_srv_registerCall() - Register call to RPC server |
* rpc_srv_registerCall() - Register call to RPC server |
* |
* |
* @srv = RPC Server instance |
* @srv = RPC Server instance |
Line 409 int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc
|
Line 489 int rpc_srv_execCall(rpc_cli_t * __restrict cli, struc
|
* |
* |
* @srv = RPC Server instance |
* @srv = RPC Server instance |
* @len = BLOB length object |
* @len = BLOB length object |
|
* @tout = BLOB live timeout in seconds |
* return: NULL error or !=NULL allocated BLOB object |
* return: NULL error or !=NULL allocated BLOB object |
*/ |
*/ |
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 |
* rpc_srv_blobMap() - Map blob to memory region |
* |
* |
Line 441 int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_b
|
Line 522 int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_b
|
* |
* |
* @srv = RPC Server instance |
* @srv = RPC Server instance |
* @len = BLOB length |
* @len = BLOB length |
|
* @tout = BLOB live timeout in seconds |
* 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, int tout); |
/* |
/* |
* rpc_srv_unregisterBLOB() - Unregister BLOB from server |
* rpc_srv_unregisterBLOB() - Unregister BLOB from server |
* |
* |
Line 486 int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b
|
Line 568 int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_b
|
* @cli = Client instance |
* @cli = Client instance |
* @var = BLOB variable |
* @var = BLOB variable |
* @data = BLOB data |
* @data = BLOB data |
* @tout = BLOB live on server timeout in seconds, if =NULL default timeout | * @tout = BLOB live on server timeout in seconds, if =0 default timeout |
* return: -1 error, 0 ok, 1 remote error |
* return: -1 error, 0 ok, 1 remote error |
*/ |
*/ |
int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, |
int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, |
void * __restrict data, int * __restrict tout); | void * __restrict data, int tout); |
/* |
/* |
* rpc_cli_recvBLOB() - Receive BLOB from server |
* rpc_cli_recvBLOB() - Receive BLOB from server |
* |
* |
Line 535 int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_va
|
Line 617 int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_va
|
rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, |
rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, |
const char *csHost, unsigned short Port, int proto); |
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 |
* rpc_cli_closeClient() - Close connection to RPC server and free resources |
* |
* |
* @cli = RPC Client session |
* @cli = RPC Client session |
Line 549 void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
|
Line 638 void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
|
* @sa = Server address |
* @sa = Server address |
* @pkt = RPC packet |
* @pkt = RPC packet |
* @len = Length of 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, |
int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, |
ait_val_t * __restrict pkt, int len); |
ait_val_t * __restrict pkt, int len); |
Line 560 int rpc_pkt_Send(int sock, int type, sockaddr_t * __re
|
Line 649 int rpc_pkt_Send(int sock, int type, sockaddr_t * __re
|
* @type = Type of socket |
* @type = Type of socket |
* @sa = Server address |
* @sa = Server address |
* @pkt = RPC packet |
* @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, |
int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, |
ait_val_t * __restrict pkt); |
ait_val_t * __restrict pkt); |
Line 581 int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_se
|
Line 670 int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_se
|
* rpc_pkt_Replay() - Decode RPC Replay packet |
* rpc_pkt_Replay() - Decode RPC Replay packet |
* |
* |
* @pkt = Packet buffer |
* @pkt = Packet buffer |
* @sess = RPC session info | * @sess = RPC session info, if =NULL don't check session |
* @tag = Function tag |
* @tag = Function tag |
* @vars = Function argument array of values, may be NULL |
* @vars = Function argument array of values, may be NULL |
* @nocrc = Without CRC calculation |
* @nocrc = Without CRC calculation |
Line 597 int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_ses
|
Line 686 int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_ses
|
* @tag = Function tag for execution |
* @tag = Function tag for execution |
* @in_vars = IN function argument array of values, may be NULL |
* @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() |
* @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, |
int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, |
array_t * __restrict in_vars, array_t ** __restrict out_vars); |
array_t * __restrict in_vars, array_t ** __restrict out_vars); |
Line 632 rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restri
|
Line 721 rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restri
|
* return: none |
* return: none |
*/ |
*/ |
void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli); |
void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli); |
|
|
|
|
|
/* |
|
* rpc_cli_openClient2() - Connect to layer2 RPC Server |
|
* |
|
* @InstID = InstID for RPC session request |
|
* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) |
|
* @csIface = Interface name for bind client, if NULL first interface on host |
|
* @csHost = Host ethernet address |
|
* return: NULL == error or !=NULL connection to RPC server established |
|
*/ |
|
rpc_cli_t *rpc_cli_openClient2(u_char InstID, int netBuf, |
|
const char *csIface, const char *csHost); |
|
/* |
|
* rpc_cli_closeClient2() - Close layer2 connection to RPC server and free resources |
|
* |
|
* @cli = RPC Client session |
|
* return: none |
|
*/ |
|
void rpc_cli_closeClient2(rpc_cli_t ** __restrict cli); |
|
|
|
|
|
/* |
|
* rpc_cli_openClientExt() - Connect to pipe RPC Server |
|
* |
|
* @InstID = InstID for RPC session request |
|
* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet) |
|
* @fd = File descriptor |
|
* return: NULL == error or !=NULL connection to RPC server established |
|
*/ |
|
rpc_cli_t *rpc_cli_openClientExt(u_char InstID, int netBuf, int fd); |
|
/* |
|
* rpc_cli_closeClientExt() - Close pipe connection to RPC server and free resources |
|
* |
|
* @cli = RPC Client session |
|
* return: none |
|
*/ |
|
void rpc_cli_closeClientExt(rpc_cli_t ** __restrict cli); |
|
|
|
|
#endif |
#endif |