libaitrpc/inc/aitrpc.h - diff

Return to aitrpc.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc

Diff for /libaitrpc/inc/aitrpc.h between versions 1.8.2.8 and 1.9.2.1

version 1.8.2.8, 2012/05/16 07:54:49	version 1.9.2.1, 2012/05/28 08:02:00
Line 72 SUCH DAMAGE.	Line 72 SUCH DAMAGE.

/* RPC builtin registed calls */	/* RPC builtin registed calls */

#define CALL_MAX_ID 65535	#define CALL_TAG_MAX 65535

#define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown"	#define CALL_SRVPING 65534
#define CALL_BLOBSHUTDOWN_ID 65530
#define CALL_BLOBCLIENTS "rpcBLOBServerClients"
#define CALL_BLOBCLIENTS_ID 65529
#define CALL_BLOBVARS "rpcBLOBServerVars"
#define CALL_BLOBVARS_ID 65528
#define CALL_BLOBSTATE "rpcBLOBServerState"
#define CALL_BLOBSTATE_ID 65527

#define CALL_SRVSHUTDOWN "rpcServerShutdown"	#define CALL_SRVSHUTDOWN 65533
#define CALL_SRVSHUTDOWN_ID 65534	#define CALL_SRVCLIENTS 65532
#define CALL_SRVCLIENTS "rpcServerClients"	#define CALL_SRVCALLS 65531
#define CALL_SRVCLIENTS_ID 65533	#define CALL_SRVSESSIONS 65530
#define CALL_SRVCALLS "rpcServerCalls"
#define CALL_SRVCALLS_ID 65532
#define CALL_SRVSESSIONS "rpcServerSessions"
#define CALL_SRVSESSIONS_ID 65531

	#define CALL_BLOBSHUTDOWN 65529
	#define CALL_BLOBCLIENTS 65528
	#define CALL_BLOBVARS 65527


/* RPC types */	/* RPC types */

typedef enum {	typedef enum {
disable, enable, running, kill, /* for blob.state */
ok, error, no, /* for blob reply */	ok, error, no, /* for blob reply */
get, set, unset /* for blob request */	get, set, unset /* for blob request */
} cmd_type_t;	} cmd_type_t;


#define RPC_CALLBACK_CHECK_INPUT(_f) do { \	#define RPC_CALLBACK_CHECK_INPUT(x) do { \
assert((_f)); \	assert((x)); \
if (!(_f)) { \	if (!(x)) { \
rpc_SetErr(EINVAL, \	rpc_SetErr(EINVAL, \
"Invalid callback parameters ..."); \	"Invalid callback parameters ..."); \
return -1; \	return -1; \
} \	} \
} while (0)	} while (0)
#define RPC_CALLBACK_CHK_ARGS(_f, _n) do { \
RPC_CALLBACK_CHECK_INPUT((_f)); \
if ((_f) && io_arraySize((_f)->func_vars) < _n) { \
rpc_SetErr(EINVAL, \
"Not enough number of arguments!"); \
return -1; \
} \
} while (0)


/* RPC session identification */	/* RPC session identification */
Line 154 struct tagRPCCall {	Line 138 struct tagRPCCall {
uint16_t call_argc;	uint16_t call_argc;
ait_val_t call_argv[0];	ait_val_t call_argv[0];
} __packed; /* size == 24 bytes */	} __packed; /* size == 24 bytes */
	#define RPC_CHK_NOREPLY(x) ((x)->call_req.flags & RPC_NOREPLY)

/* Network BLOB packet - Header */	/* Network BLOB packet - Header */

Line 165 struct tagBLOBHdr {	Line 150 struct tagBLOBHdr {
uint32_t hdr_ret;	uint32_t hdr_ret;
uint16_t hdr_crc;	uint16_t hdr_crc;
uint8_t hdr_pad;	uint8_t hdr_pad;
} __packed;	} __packed; /* size == 22 bytes */

/* Network RPC client & server elements */	/* Network RPC client & server elements */

Line 173 struct tagBLOBHdr {	Line 158 struct tagBLOBHdr {
typedef struct tagRPCFunc {	typedef struct tagRPCFunc {
ait_val_t func_name;	ait_val_t func_name;

array_t *func_vars;

void *func_parent;	void *func_parent;
TAILQ_ENTRY(tagRPCFunc) func_node;	TAILQ_ENTRY(tagRPCFunc) func_node;
} rpc_func_t;	} rpc_func_t;
	#define RPC_FUNC_SERVER(x) ((rpc_srv_t*) (x)->func_parent)


/* BLOB register element */	/* BLOB register element */
Line 197 typedef struct {	Line 181 typedef struct {
io_sockaddr_t cli_sa; /* host address */	io_sockaddr_t cli_sa; /* host address */
ait_val_t cli_buf; /* network buffer */	ait_val_t cli_buf; /* network buffer */

	array_t cli_vars; / function return variables */

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 */
} rpc_cli_t;	} rpc_cli_t;
	#define RPC_RETVARS(x) ((x)->cli_vars)
	#define RPC_SRV_SERVER(x) ((rpc_srv_t*) (x)->cli_parent)
	#define RPC_CLI_SESSION(x) ((rpc_sess_t*) (x)->cli_parent)

typedef struct {	typedef struct {
rpc_sess_t srv_session; /* RPC session registration info */	rpc_sess_t srv_session; /* RPC session registration info */
int srv_netbuf; /* size of network buffer */	int srv_netbuf; /* size of network buffer */

	pthread_t srv_tid; /* RPC exec pthread */
sched_root_task_t srv_root; / RPC server scheduler */	sched_root_task_t srv_root; / RPC server scheduler */
intptr_t srv_kill; /* Scheduler condition variable */	intptr_t srv_kill; /* Scheduler condition variable */

Line 213 typedef struct {	Line 203 typedef struct {
TAILQ_HEAD(, tagRPCFunc) srv_funcs; /* RPC functions list */	TAILQ_HEAD(, tagRPCFunc) srv_funcs; /* RPC functions list */

struct {	struct {
cmd_type_t state; /* BLOB server state: ==0 disable \| !=0 enable */	pthread_t tid; /* BLOB exec pthread */
	sched_root_task_t root; / BLOB server scheduler */
	intptr_t kill; /* BLOB server state: ==0 disable \| !=0 enable */

ait_val_t dir; /* BLOB states directory */	ait_val_t dir; /* BLOB states directory */

rpc_cli_t server; /* BLOB server socket */	rpc_cli_t server; /* BLOB server socket */
Line 227 typedef struct {	Line 220 typedef struct {
/*	/*
* (*rpc_callback_t)() - Callback type definition for RPC call in server process	* (*rpc_callback_t)() - Callback type definition for RPC call in server process
*	*
* @arg1 = current execution RPC call function	* @arg1 = RPC client
* @arg2 = number of items in input array from call request	* @arg2 = RPC packet header
* @arg3 = input array with values from RPC call execution request	* @arg3 = input array with values from RPC call execution request
* return: -1 error or >-1 success execution	* return: -1 error or >-1 success execution
*/	*/
typedef int (rpc_callback_t)(rpc_func_t , int, array_t *);	typedef int (rpc_callback_t)(rpc_cli_t , struct tagRPCCall , array_t );


// -----------------------------------------------------------------------	/* ----------------------------------------------------------------------- */

/* Error support functions */	/* Error support functions */

Line 262 inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t	Line 255 inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t
*/	*/
inline int rpc_addPktSession(rpc_sess_t p, rpc_sess_t s);	inline 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);
	/*
* rpc_register_srvServices() - Register internal service functions	* rpc_register_srvServices() - Register internal service functions
*	*
* @srv = RPC server instance	* @srv = RPC server instance
Line 285 int rpc_register_blobServices(rpc_srv_t * __restrict s	Line 285 int rpc_register_blobServices(rpc_srv_t * __restrict s
* @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
* @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)	* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
* @csHost = Host name or 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 299 rpc_srv_t *rpc_srv_initServer(unsigned int regProgID,	Line 299 rpc_srv_t *rpc_srv_initServer(unsigned int regProgID,
* @psrv = RPC Server instance	* @psrv = RPC Server instance
* return: none	* return: none
*/	*/
void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);	inline void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
/*	/*
* rpc_srv_loopServer() - Execute Main server loop and wait for clients requests	* rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
*	*
Line 307 void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);	Line 307 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)); pthread_t __tid; \	#define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \
pthread_create(&__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(__tid, (void**) (_sync)); \	if ((_sync)) \
else \	pthread_join((_srv)->srv_tid, (void**) (_sync)); \
pthread_detach(__tid); \	else \
} while (0)	pthread_detach((_srv)->srv_tid); \
	} } while (0)

/*	/*
* rpc_srv_initBLOBServer() - Init & create BLOB Server	* rpc_srv_initBLOBServer() - Init & create BLOB Server
Line 324 int rpc_srv_loopServer(rpc_srv_t * __restrict srv);	Line 325 int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
* @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
*/	*/
int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);	int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
/*	/*
* rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources	* rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
*	*
* @srv = RPC Server instance	* @srv = RPC Server instance
* return: none	* return: none
*/	*/
void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);	inline void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
/*	/*
* rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests	* rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
*	*
* @srv = RPC Server instance	* @srv = RPC Server instance
* return: -1 error or 0 ok, infinite loop ...	* return: -1 error or 0 ok, infinite loop ...
*/	*/
int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);	int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); pthread_t __tid; \	#define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \
if ((_srv)->srv_blob.state == enable) { \	if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
pthread_create(&__tid, NULL, (void()(void*)) \	pthread_create(&(_srv)->srv_blob.tid, NULL, \
rpc_srv_loopBLOB, (_srv)); \	(void()(void*)) \
pthread_detach(__tid); \	rpc_srv_loopBLOBServer, (_srv)); \
(_srv)->srv_blob.state = running; \	pthread_detach((_srv)->srv_blob.tid); \
} \	} \
} while (0)	} while (0)

Line 354 int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);	Line 355 int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
* @srv = RPC Server instance	* @srv = RPC Server instance
* @tag = Function tag	* @tag = Function tag
* @funcaddr = Function address	* @funcaddr = Function address
* @args = Number of return function arguments
* return: -1 error, 0 already registered tag or 1 register ok	* return: -1 error, 0 already registered tag or 1 register ok
*/	*/
int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag,	int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
void *funcaddr, unsigned short args);
/*	/*
* rpc_srv_unregisterCall() - Unregister call from RPC server	* rpc_srv_unregisterCall() - Unregister call from RPC server
*	*
Line 376 int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv,	Line 375 int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv,
*/	*/
inline rpc_func_t rpc_srv_getCall(rpc_srv_t __restrict srv, uint16_t tag);	inline rpc_func_t rpc_srv_getCall(rpc_srv_t __restrict srv, uint16_t tag);
/*	/*
* rpc_srv_execCall() - Execute registered call from RPC server	* rpc_srv_execCall() Execute registered call from RPC server
*	*
* @call = Register RPC call	* @cli = RPC client
* @rpc = IN RPC call structure	* @rpc = IN RPC call structure
	* @funcname = Execute RPC function
* @args = IN RPC calling arguments from RPC client	* @args = IN RPC calling arguments from RPC client
* return: -1 error, !=-1 ok	* return: -1 error, !=-1 ok
*/	*/
int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,	int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc,
array_t * __restrict args);	ait_val_t funcname, array_t * __restrict args);


/*	/*
* rpc_srv_blobCreate() - Create map blob to memory region and return object	* rpc_srv_blobCreate() - Create and map blob to memory region and return object
*	*
* @srv = RPC Server instance	* @srv = RPC Server instance
* @len = BLOB length object	* @len = BLOB length object
Line 477 int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v	Line 477 int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v
*	*
* @cli = Client instance	* @cli = Client instance
* @var = BLOB variable	* @var = BLOB variable
* @data = BLOB data, must be free after use!	* @data = BLOB data, must be io_free after use!
* 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, ait_val_t * __restrict var, void ** __restrict data);	int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
Line 494 int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va	Line 494 int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va
*	*
* @cli = Client instance	* @cli = Client instance
* @var = BLOB variable	* @var = BLOB variable
* @data = BLOB data, must be free after use!	* @data = BLOB data, must be io_free after use!
* return: -1 error, 0 ok, >0 remote error	* return: -1 error, 0 ok, >0 remote error
*/	*/
inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,	inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
Line 508 inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,	Line 508 inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
*	*
* @ProgID = ProgramID for RPC session request	* @ProgID = ProgramID for RPC session request
* @ProcID = ProcessID for RPC session request	* @ProcID = ProcessID for RPC session request
* @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)	* @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
* @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
* @family = Family socket type, AF_INET or AF_INET6
* @csHost = Host name or IP address for bind server	* @csHost = Host name or IP address for bind server
* @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(unsigned int ProgID, unsigned int ProcID, int netBuf,	rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf,
unsigned char Timeout, unsigned short family,
const char *csHost, unsigned short Port);	const char *csHost, unsigned short Port);
/*	/*
* rpc_cli_closeClient() - Close connection to RPC server and free resources	* rpc_cli_closeClient() - Close connection to RPC server and free resources
Line 524 rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns	Line 521 rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns
* @cli = RPC Client session	* @cli = RPC Client session
* return: none	* return: none
*/	*/
void rpc_cli_closeClient(rpc_cli_t * __restrict cli);	void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
/*	/*
* rpc_cli_execCall() - Execute RPC call	* rpc_cli_execCall() - Execute RPC call
*	*
* @cli = RPC Client session	* @cli = RPC Client session
* @noreply = We not want RPC reply	* @noreply = We not want RPC reply
* @csModule = Module name, if NULL self binary	* @tag = Function tag for execution
* @csFunc = Function name for execute	* @in_vars = IN RPC call array of rpc values, may be NULL
* @in_vars = IN RPC call array of rpc values	* @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars()
* @out_vars = OUT returned array of rpc values, must be free after use with 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, int noreply, const char csModule, const char *csFunc,	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);
	/*
	* 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);


/*	/*
Line 547 int rpc_cli_execCall(rpc_cli_t *cli, int noreply, cons	Line 550 int rpc_cli_execCall(rpc_cli_t *cli, int noreply, cons
* @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 BLOB server established	* 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_t rpc_cli_openBLOBClient(rpc_cli_t __restrict rpccli, unsigned short Port);
/*	/*
* rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources	* rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
*	*
* @cli = BLOB Client session	* @cli = BLOB Client session
* return: none	* return: none
*/	*/
void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);	void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);


#endif	#endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.8.2.8
changed lines
	Added in v.1.9.2.1