File:  [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc / aitrpc.h
Revision 1.21: download - view: text, annotated - select for diffs - revision graph
Fri Nov 22 13:41:33 2013 UTC (10 years, 7 months ago) by misho
Branches: MAIN
CVS tags: rpc6_7, RPC6_6, HEAD
version 6.6

    1: /*************************************************************************
    2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
    3: *  by Michael Pounov <misho@openbsd-bg.org>
    4: *
    5: * $Author: misho $
    6: * $Id: aitrpc.h,v 1.21 2013/11/22 13:41:33 misho Exp $
    7: *
    8: **************************************************************************
    9: The ELWIX and AITNET software is distributed under the following
   10: terms:
   11: 
   12: All of the documentation and software included in the ELWIX and AITNET
   13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   14: 
   15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
   16: 	by Michael Pounov <misho@elwix.org>.  All rights reserved.
   17: 
   18: Redistribution and use in source and binary forms, with or without
   19: modification, are permitted provided that the following conditions
   20: are met:
   21: 1. Redistributions of source code must retain the above copyright
   22:    notice, this list of conditions and the following disclaimer.
   23: 2. Redistributions in binary form must reproduce the above copyright
   24:    notice, this list of conditions and the following disclaimer in the
   25:    documentation and/or other materials provided with the distribution.
   26: 3. All advertising materials mentioning features or use of this software
   27:    must display the following acknowledgement:
   28: This product includes software developed by Michael Pounov <misho@elwix.org>
   29: ELWIX - Embedded LightWeight unIX and its contributors.
   30: 4. Neither the name of AITNET nor the names of its contributors
   31:    may be used to endorse or promote products derived from this software
   32:    without specific prior written permission.
   33: 
   34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
   35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   44: SUCH DAMAGE.
   45: */
   46: #ifndef __AITRPC_H
   47: #define __AITRPC_H
   48: 
   49: 
   50: #include <assert.h>
   51: #include <stdlib.h>
   52: #include <string.h>
   53: #include <errno.h>
   54: #include <sys/types.h>
   55: #include <sys/param.h>
   56: #if !defined(__NetBSD__)
   57: #include <sys/limits.h>
   58: #endif
   59: #include <sys/socket.h>
   60: #include <sys/queue.h>
   61: #include <elwix.h>
   62: #include <aitsched.h>
   63: 
   64: 
   65: #define RPC_VERSION		7
   66: #define RPC_DEFPORT		2611
   67: 
   68: /* RPC call request flags */
   69: 
   70: #define RPC_REPLY		0x0
   71: #define RPC_NOREPLY		0x1
   72: 
   73: /* RPC builtin registed calls */
   74: 
   75: #define CALL_TAG_MAX		65535
   76: 
   77: #define CALL_SRVPING		65534
   78: 
   79: #define CALL_SRVSHUTDOWN	65533
   80: #define CALL_SRVCLIENTS		65532
   81: #define CALL_SRVCALLS		65531
   82: #define CALL_SRVSESSIONS	65530
   83: 
   84: #define CALL_BLOBSHUTDOWN	65529
   85: #define CALL_BLOBCLIENTS	65528
   86: #define CALL_BLOBVARS		65527
   87: 
   88: /* RPC signals */
   89: #define SIGFBLOB		54
   90: 
   91: /* RPC types */
   92: 
   93: typedef enum {
   94: 	ok, error, no, 				/* for blob reply */
   95: 	get, set, unset				/* for blob request */
   96: } blob_cmd_type_t;
   97: 
   98: 
   99: #define RPC_CALLBACK_CHECK_INPUT(x)	do { \
  100: 						assert((x)); \
  101: 						if (!(x)) { \
  102: 							rpc_SetErr(EINVAL, \
  103: 									"Invalid callback parameters ..."); \
  104: 							return -1; \
  105: 						} \
  106: 					} while (0)
  107: 
  108: 
  109: /* RPC session identification */
  110: 
  111: typedef struct {
  112: #if BYTE_ORDER == LITTLE_ENDIAN
  113: 	uint16_t	sess_instance:8;
  114: 	uint16_t	sess_version:8;
  115: #endif
  116: #if BYTE_ORDER == BIG_ENDIAN
  117: 	uint16_t	sess_version:8;
  118: 	uint16_t	sess_instance:8;
  119: #endif
  120: } __packed rpc_sess_t;	/* size == 2 bytes */
  121: 
  122: 
  123: /* Server managment RPC functions ... */
  124: 
  125: /* Network RPC packet - Client request */
  126: 
  127: struct tagRPCCall {
  128: 	rpc_sess_t	call_session;
  129: 
  130: 	uint32_t	call_len;
  131: 	uint16_t	call_crc;
  132: 
  133: 	union {
  134: 		struct {
  135: 			uint64_t	flags;
  136: 		}	call_req;
  137: 		struct {
  138: 			int32_t		ret;
  139: 			int32_t		eno;
  140: 		}	call_rep;
  141: 	};
  142: 
  143: 	uint16_t	call_tag;
  144: 	uint16_t	call_argc;
  145: 	ait_val_t	call_argv[0];
  146: } __packed;			/* size == 20 bytes */
  147: #define RPC_CHK_NOREPLY(x)	(ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY)
  148: #define RPC_SET_ERRNO(x, _v)	((x)->call_rep.eno = htonl((_v)))
  149: 
  150: /* Network BLOB packet - Header */
  151: 
  152: struct tagBLOBHdr {
  153: 	rpc_sess_t	hdr_session;
  154: 	uint8_t		hdr_cmd;
  155: 	uint32_t	hdr_var;
  156: 	uint32_t	hdr_len;
  157: 	uint32_t	hdr_ret;
  158: 	uint8_t		hdr_pad;
  159: } __packed;			/* size == 16 bytes */
  160: 
  161: /* Network RPC client & server elements */
  162: 
  163: /* RPC function registration element! */
  164: typedef struct tagRPCFunc {
  165: 	ait_val_t		func_name;
  166: 
  167: 	void			*func_parent;
  168: 
  169: 	SLIST_ENTRY(tagRPCFunc)	func_next;
  170: 	AVL_ENTRY(tagRPCFunc)	func_node;
  171: } rpc_func_t;
  172: #define RPC_FUNC_SERVER(x)	((rpc_srv_t*) (x)->func_parent)
  173: 
  174: /* Tree root node */
  175: typedef struct tagRPCFuncs {
  176: 	pthread_mutex_t		mtx;
  177: 
  178: 	struct tagRPCFunc	*slh_first;
  179: 	struct tagRPCFunc	*avlh_root;
  180: } rpc_funcs_t;
  181: #define RPC_FUNCS_LOCK(x)	pthread_mutex_lock(&(x)->mtx)
  182: #define RPC_FUNCS_UNLOCK(x)	pthread_mutex_unlock(&(x)->mtx)
  183: #define RPC_FUNCS_ISEMPTY(x)	AVL_EMPTY((x))
  184: 
  185: 
  186: /* BLOB register element */
  187: typedef struct tagBLOB {
  188: 	uint32_t		blob_var;	/* BLOB id */
  189: 
  190: 	size_t			blob_len;	/* size of allocated BLOB data */
  191: 	void			*blob_data;	/* mapped BLOB data */
  192: 
  193: 	TAILQ_ENTRY(tagBLOB)	blob_node;
  194: } rpc_blob_t;
  195: 
  196: 
  197: typedef struct {
  198: 	int		cli_id;		/* slot id */
  199: 	int		cli_sock;	/* socket fd */
  200: 	sockaddr_t	cli_sa;		/* host address */
  201: 	ait_val_t	cli_buf;	/* network buffer */
  202: 
  203: 	array_t		*cli_vars;	/* function return variables */
  204: 
  205: 	void		*cli_parent;	/* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
  206: } rpc_cli_t;
  207: #define RPC_RETVARS(x)		((x)->cli_vars)
  208: #define RPC_SRV_SERVER(x)	((rpc_srv_t*) (x)->cli_parent)
  209: #define RPC_CLI_SESSION(x)	((rpc_sess_t*) (x)->cli_parent)
  210: 
  211: typedef struct {
  212: 	rpc_sess_t			srv_session;	/* RPC session registration info */
  213: 	int				srv_netbuf;	/* size of network buffer */
  214: 	int				srv_proto;	/* Server protocol */
  215: 
  216: 	pthread_t			srv_tid;	/* RPC exec pthread */
  217: 	sched_root_task_t		*srv_root;	/* RPC server scheduler */
  218: 	intptr_t			srv_kill;	/* Scheduler condition variable */
  219: 
  220: 	rpc_cli_t			srv_server;	/* RPC server socket */
  221: 	array_t				*srv_clients;	/* connected rpc client sockets */
  222: 
  223: 	rpc_funcs_t			srv_funcs;	/* RPC functions */
  224: 
  225: 	struct {
  226: 		pthread_t			tid;		/* BLOB exec pthread */
  227: 		sched_root_task_t		*root;		/* BLOB server scheduler */
  228: 		intptr_t			kill;		/* BLOB server state: ==0 disable | !=0 enable */
  229: 
  230: 		ait_val_t			dir;		/* BLOB states directory */
  231: 
  232: 		rpc_cli_t			server;		/* BLOB server socket */
  233: 		array_t				*clients;	/* connected blob client sockets */
  234: 
  235: 		TAILQ_HEAD(, tagBLOB)		blobs;		/* registered blob variables list */
  236: 	} 				srv_blob;
  237: } rpc_srv_t;
  238: 
  239: 
  240: /* 
  241:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
  242:  *
  243:  * @arg1 = RPC client
  244:  * @arg2 = RPC packet header
  245:  * @arg3 = input array with values from RPC call execution request
  246:  * return: -1 error or >-1 success execution
  247:  */
  248: typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *);
  249: 
  250: 
  251: /* ----------------------------------------------------------------------- */
  252: 
  253: /* Error support functions */
  254: 
  255: // rpc_GetErrno() Get error code of last operation
  256: int rpc_GetErrno();
  257: // rpc_GetError() Get error text of last operation
  258: const char *rpc_GetError();
  259: // rpc_SetErr() Set error to variables for internal use!!!
  260: void rpc_SetErr(int eno, char *estr, ...);
  261: 
  262: 
  263: 
  264: /*
  265:  * rpc_Read() - RPC read operation
  266:  *
  267:  * @sock = socket
  268:  * @type = type of socket
  269:  * @flags = receive flags
  270:  * @sa = check client address, if you use udp protocol
  271:  * @buf = buffer
  272:  * @blen = buffer length
  273:  * return: -1 error or >-1 readed bytes into buffer
  274:  */
  275: ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa, 
  276: 		unsigned char * __restrict buf, size_t blen);
  277: /*
  278:  * rpc_Write() - RPC write operation
  279:  *
  280:  * @sock = socket
  281:  * @type = type of socket
  282:  * @flags = send flags
  283:  * @sa = send to client address, if you use udp protocol
  284:  * @buf = buffer
  285:  * @blen = buffer length
  286:  * return: -1 error or >-1 written bytes into buffer
  287:  */
  288: ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa, 
  289: 		unsigned char * __restrict buf, size_t blen);
  290: 
  291: /*
  292:  * rpc_chkPktSession() - Check RPC session
  293:  *
  294:  * @p = packet session
  295:  * @s = active session
  296:  * return: -1, 1, 2, 3 are errors or 0 ok
  297:  */
  298: int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
  299: /*
  300:  * rpc_addPktSession() - Prepare session into network format
  301:  *
  302:  * @p = packet session
  303:  * @s = host session
  304:  * return: -1 error or 0 ok
  305:  */
  306: int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
  307: /*
  308:  * rpc_register_srvPing() - Register ping service function
  309:  *
  310:  * @srv = RPC server instance
  311:  * return: -1 error or 0 ok
  312:  */
  313: int rpc_register_srvPing(rpc_srv_t * __restrict srv);
  314: /*
  315:  * rpc_register_srvServices() - Register internal service functions
  316:  *
  317:  * @srv = RPC server instance
  318:  * return: -1 error or 0 ok
  319:  */
  320: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
  321: /*
  322:  * rpc_register_blobServices() - Register internal service functions
  323:  *
  324:  * @srv = RPC server instance
  325:  * return: -1 error or 0 ok
  326:  */
  327: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
  328: 
  329: 
  330: /* RPC Server side functions */
  331: 
  332: /*
  333:  * rpc_srv_initServer() - Init & create RPC Server
  334:  *
  335:  * @InstID = Instance for authentication & recognition
  336:  * @concurentClients = Concurent clients at same time to this server
  337:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  338:  * @csHost = Host name or address for bind server, if NULL any address
  339:  * @Port = Port for bind server, if Port == 0 default port is selected
  340:  * @proto = Protocol, if == 0 choose SOCK_STREAM
  341:  * return: NULL == error or !=NULL bind and created RPC server instance
  342:  */
  343: rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, 
  344: 		const char *csHost, unsigned short Port, int proto);
  345: /*
  346:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
  347:  *
  348:  * @psrv = RPC Server instance
  349:  * return: none
  350:  */
  351: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
  352: /*
  353:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
  354:  *
  355:  * @srv = RPC Server instance
  356:  * return: -1 error or 0 ok, infinite loop ...
  357:  */
  358: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
  359: #define rpc_srv_execServer(_srv, _sync)	do { assert((_srv)); \
  360: 						if (!(_srv)->srv_kill) { \
  361: 							pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
  362: 									rpc_srv_loopServer, (_srv)); \
  363: 							if ((_sync)) \
  364: 								pthread_join((_srv)->srv_tid, (void**) (_sync)); \
  365: 							else \
  366: 								pthread_detach((_srv)->srv_tid); \
  367: 						} } while (0)
  368: #define rpc_srv_killServer(_srv)	(assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1)
  369: 
  370: /*
  371:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
  372:  *
  373:  * @srv = RPC server instance
  374:  * @Port = Port for bind server, if Port == 0 default port is selected
  375:  * @diskDir = Disk place for BLOB file objects
  376:  * return: -1 == error or 0 bind and created BLOB server instance
  377:  */
  378: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
  379: /*
  380:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
  381:  *
  382:  * @srv = RPC Server instance
  383:  * return: none
  384:  */
  385: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
  386: /*
  387:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
  388:  *
  389:  * @srv = RPC Server instance
  390:  * return: -1 error or 0 ok, infinite loop ...
  391:  */
  392: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
  393: #define rpc_srv_execBLOBServer(_srv)	do { assert((_srv)); \
  394: 						if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
  395: 							pthread_create(&(_srv)->srv_blob.tid, NULL, \
  396: 									(void*(*)(void*)) \
  397: 									rpc_srv_loopBLOBServer, (_srv)); \
  398: 							pthread_detach((_srv)->srv_blob.tid); \
  399: 						} \
  400: 					} while (0)
  401: 
  402: /*
  403:  * rpc_srv_registerCall() - Register call to RPC server
  404:  *
  405:  * @srv = RPC Server instance
  406:  * @tag = Function tag
  407:  * @funcaddr = Function address
  408:  * return: -1 error, 0 already registered tag or 1 register ok
  409:  */
  410: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
  411: /*
  412:  * rpc_srv_unregisterCall() - Unregister call from RPC server
  413:  *
  414:  * @srv = RPC Server instance
  415:  * @tag = Function tag
  416:  * return: -1 error, 0 not found call, 1 unregister ok
  417:  */
  418: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
  419: /*
  420:  * rpc_srv_getCall()  - Get registered call from RPC server
  421:  *
  422:  * @srv = RPC Server instance
  423:  * @tag = tag for function
  424:  * return: NULL not found call, !=NULL return call
  425:  */
  426: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
  427: /*
  428:  * rpc_srv_execCall() Execute registered call from RPC server
  429:  *
  430:  * @cli = RPC client
  431:  * @rpc = IN RPC call structure
  432:  * @funcname = Execute RPC function
  433:  * @args = IN RPC calling arguments from RPC client
  434:  * return: -1 error, !=-1 ok
  435:  */
  436: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc, 
  437: 		ait_val_t funcname, array_t * __restrict args);
  438: 
  439: 
  440: /*
  441:  * rpc_srv_blobCreate() - Create and map blob to memory region and return object
  442:  *
  443:  * @srv = RPC Server instance
  444:  * @len = BLOB length object
  445:  * @tout = BLOB live timeout in seconds
  446:  * return: NULL error or !=NULL allocated BLOB object
  447:  */
  448: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
  449: /*
  450:  * rpc_srv_blobMap() - Map blob to memory region 
  451:  *
  452:  * @srv = RPC Server instance
  453:  * @blob = Map to this BLOB element
  454:  * return: -1 error or 0 ok
  455:  */
  456: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
  457: /*
  458:  * rpc_srv_blobUnmap() - Unmap blob memory region 
  459:  *
  460:  * @blob = Mapped BLOB element
  461:  * return: none
  462:  */
  463: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
  464: /*
  465:  * rpc_srv_blobFree() - Free blob from disk & memory
  466:  *
  467:  * @srv = RPC Server instance
  468:  * @blob = Mapped BLOB element
  469:  * return: -1 error or 0 ok
  470:  */
  471: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
  472: 
  473: /*
  474:  * rpc_srv_registerBLOB() - Register new BLOB to server
  475:  *
  476:  * @srv = RPC Server instance
  477:  * @len = BLOB length
  478:  * @tout = BLOB live timeout in seconds
  479:  * return: NULL error or new registered BLOB
  480:  */
  481: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
  482: /*
  483:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
  484:  *
  485:  * @srv = RPC Server instance
  486:  * @var = BLOB Variable for unregister
  487:  * return: -1 error, 0 not found call, 1 unregister ok
  488:  */
  489: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
  490: /*
  491:  * rpc_srv_getBLOB() - Get registered BLOB 
  492:  *
  493:  * @srv = RPC Server instance
  494:  * @var = hash for variable
  495:  * return: NULL not found, !=NULL return blob var
  496:  */
  497: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
  498: 
  499: /*
  500:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
  501:  *
  502:  * @cli = Client instance
  503:  * @blob = Mapped BLOB element
  504:  * return: -1 error, 0 ok
  505:  */
  506: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
  507: /*
  508:  * rpc_srv_recvBLOB() - Receive BLOB from client
  509:  *
  510:  * @cli = Client instance
  511:  * @blob = Mapped BLOB element
  512:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
  513:  */
  514: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
  515: 
  516: /* CLIENT part of functions */
  517: 
  518: /*
  519:  * rpc_cli_sendBLOB() - Send BLOB to server
  520:  *
  521:  * @cli = Client instance
  522:  * @var = BLOB variable
  523:  * @data = BLOB data
  524:  * @tout = BLOB live on server timeout in seconds, if =0 default timeout
  525:  * return: -1 error, 0 ok, 1 remote error
  526:  */
  527: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
  528: 		void * __restrict data, int tout);
  529: /*
  530:  * rpc_cli_recvBLOB() - Receive BLOB from server
  531:  *
  532:  * @cli = Client instance
  533:  * @var = BLOB variable
  534:  * @data = BLOB data, must be e_free after use!
  535:  * return: -1 error, 0 ok, 1 remote error
  536:  */
  537: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
  538: /*
  539:  * rpc_cli_delBLOB() - Delete BLOB from server
  540:  *
  541:  * @cli = Client instance
  542:  * @var = BLOB variable
  543:  * return: -1 error, 0 ok, 1 remote error
  544:  */
  545: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
  546: /*
  547:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
  548:  *
  549:  * @cli = Client instance
  550:  * @var = BLOB variable
  551:  * @data = BLOB data, must be e_free after use!
  552:  * return: -1 error, 0 ok, >0 remote error
  553:  */
  554: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
  555: 		void ** __restrict data);
  556: 
  557: 
  558: /* RPC Client side functions */
  559: 
  560: /*
  561:  * rpc_cli_openClient() - Connect to RPC Server
  562:  *
  563:  * @InstID = InstID for RPC session request
  564:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  565:  * @csHost = Host name or IP address for bind server
  566:  * @Port = Port for bind server, if Port == 0 default port is selected
  567:  * @proto = Protocol, if == 0 choose SOCK_STREAM
  568:  * return: NULL == error or !=NULL connection to RPC server established
  569:  */
  570: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, 
  571: 		const char *csHost, unsigned short Port, int proto);
  572: /*
  573:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
  574:  *
  575:  * @cli = RPC Client session
  576:  * return: none
  577:  */
  578: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
  579: /*
  580:  * rpc_pkt_Send() - Send RPC packet
  581:  *
  582:  * @sock = Socket
  583:  * @type = Type of socket
  584:  * @sa = Server address
  585:  * @pkt = RPC packet
  586:  * @len = Length of packet
  587:  * return: -1 error or !=-1 sended bytes
  588:  */
  589: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, 
  590: 		ait_val_t * __restrict pkt, int len);
  591: /*
  592:  * rpc_pkt_Receive() - Receive RPC packet
  593:  *
  594:  * @sock = Socket
  595:  * @type = Type of socket
  596:  * @sa = Server address
  597:  * @pkt = RPC packet
  598:  * return: -1 error or !=-1 sended bytes
  599:  */
  600: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, 
  601: 		ait_val_t * __restrict pkt);
  602: /*
  603:  * rpc_pkt_Request() - Build RPC Request packet
  604:  *
  605:  * @pkt = Packet buffer
  606:  * @sess = RPC session info
  607:  * @tag = Function tag for execution
  608:  * @vars = Function argument array of values, may be NULL
  609:  * @noreply = We not want RPC reply
  610:  * @nocrc = Without CRC calculation
  611:  * return: -1 error or != -1 prepared bytes into packet
  612:  */
  613: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
  614: 		unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
  615: /*
  616:  * rpc_pkt_Replay() - Decode RPC Replay packet
  617:  *
  618:  * @pkt = Packet buffer
  619:  * @sess = RPC session info
  620:  * @tag = Function tag
  621:  * @vars = Function argument array of values, may be NULL
  622:  * @nocrc = Without CRC calculation
  623:  * return: -1 error or != -1 return value from function
  624:  */
  625: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
  626: 		unsigned short tag, array_t ** __restrict vars, int nocrc);
  627: /*
  628:  * rpc_cli_execCall() - Execute RPC call
  629:  *
  630:  * @cli = RPC Client session
  631:  * @noreply = We not want RPC reply
  632:  * @tag = Function tag for execution
  633:  * @in_vars = IN function argument array of values, may be NULL
  634:  * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
  635:  * return: -1 error or != -1 ok result
  636:  */
  637: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, 
  638: 		array_t * __restrict in_vars, array_t ** __restrict out_vars);
  639: /*
  640:  * rpc_cli_freeCall() - Free resouce allocated by RPC call
  641:  *
  642:  * @out_vars = Returned array with variables from RPC call
  643:  * return: none
  644:  */
  645: void rpc_cli_freeCall(array_t ** __restrict out_vars);
  646: /*
  647:  * rpc_cli_ping() - Ping RPC server
  648:  *
  649:  * @cli = connected client
  650:  * return: -1 error or !=-1 ping seq id
  651:  */
  652: int rpc_cli_ping(rpc_cli_t *cli);
  653: 
  654: 
  655: /*
  656:  * rpc_cli_openBLOBClient() - Connect to BLOB Server
  657:  *
  658:  * @rpccli = RPC Client session
  659:  * @Port = Port for bind server, if Port == 0 default port is selected
  660:  * return: NULL == error or !=NULL connection to BLOB server established
  661:  */
  662: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
  663: /*
  664:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
  665:  *
  666:  * @cli = BLOB Client session
  667:  * return: none
  668:  */
  669: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
  670: 
  671: 
  672: #endif

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