File:  [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc / aitrpc.h
Revision 1.17.2.2: download - view: text, annotated - select for diffs - revision graph
Wed Aug 21 09:42:11 2013 UTC (10 years, 10 months ago) by misho
Branches: rpc5_5
Diff to: branchpoint 1.17: preferred, unified
change rxPacket and execCall

    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.17.2.2 2013/08/21 09:42:11 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		6
   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)	((x)->call_req.flags & RPC_NOREPLY)
  148: 
  149: /* Network BLOB packet - Header */
  150: 
  151: struct tagBLOBHdr {
  152: 	rpc_sess_t	hdr_session;
  153: 	uint8_t		hdr_cmd;
  154: 	uint32_t	hdr_var;
  155: 	uint32_t	hdr_len;
  156: 	uint32_t	hdr_ret;
  157: 	uint8_t		hdr_pad;
  158: } __packed;			/* size == 16 bytes */
  159: 
  160: /* Network RPC client & server elements */
  161: 
  162: /* RPC function registration element! */
  163: typedef struct tagRPCFunc {
  164: 	ait_val_t		func_name;
  165: 
  166: 	void			*func_parent;
  167: 
  168: 	SLIST_ENTRY(tagRPCFunc)	func_next;
  169: 	AVL_ENTRY(tagRPCFunc)	func_node;
  170: } rpc_func_t;
  171: #define RPC_FUNC_SERVER(x)	((rpc_srv_t*) (x)->func_parent)
  172: 
  173: /* Tree root node */
  174: typedef struct tagRPCFuncs {
  175: 	pthread_mutex_t		mtx;
  176: 
  177: 	struct tagRPCFunc	*slh_first;
  178: 	struct tagRPCFunc	*avlh_root;
  179: } rpc_funcs_t;
  180: #define RPC_FUNCS_LOCK(x)	pthread_mutex_lock(&(x)->mtx)
  181: #define RPC_FUNCS_UNLOCK(x)	pthread_mutex_unlock(&(x)->mtx)
  182: #define RPC_FUNCS_ISEMPTY(x)	AVL_EMPTY((x))
  183: 
  184: 
  185: /* BLOB register element */
  186: typedef struct tagBLOB {
  187: 	uint32_t		blob_var;	/* BLOB id */
  188: 
  189: 	size_t			blob_len;	/* size of allocated BLOB data */
  190: 	void			*blob_data;	/* mapped BLOB data */
  191: 
  192: 	TAILQ_ENTRY(tagBLOB)	blob_node;
  193: } rpc_blob_t;
  194: 
  195: 
  196: typedef struct {
  197: 	int		cli_id;		/* slot id */
  198: 	int		cli_sock;	/* socket fd */
  199: 	sockaddr_t	cli_sa;		/* host address */
  200: 	array_t		*cli_buf;	/* network buffer(s) */
  201: 
  202: 	array_t		*cli_vars;	/* function return variables */
  203: 
  204: 	void		*cli_parent;	/* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
  205: } rpc_cli_t;
  206: #define RPC_RETVARS(x)		((x)->cli_vars)
  207: #define RPC_SRV_SERVER(x)	((rpc_srv_t*) (x)->cli_parent)
  208: #define RPC_CLI_SESSION(x)	((rpc_sess_t*) (x)->cli_parent)
  209: 
  210: typedef struct {
  211: 	rpc_sess_t			srv_session;	/* RPC session registration info */
  212: 	int				srv_netbuf;	/* size of network buffer */
  213: 	int				srv_proto;	/* Server protocol */
  214: 
  215: 	pthread_t			srv_tid;	/* RPC exec pthread */
  216: 	sched_root_task_t		*srv_root;	/* RPC server scheduler */
  217: 	intptr_t			srv_kill;	/* Scheduler condition variable */
  218: 
  219: 	rpc_cli_t			srv_server;	/* RPC server socket */
  220: 	array_t				*srv_clients;	/* connected rpc client sockets */
  221: 
  222: 	rpc_funcs_t			srv_funcs;	/* RPC functions */
  223: 
  224: 	struct {
  225: 		pthread_t			tid;		/* BLOB exec pthread */
  226: 		sched_root_task_t		*root;		/* BLOB server scheduler */
  227: 		intptr_t			kill;		/* BLOB server state: ==0 disable | !=0 enable */
  228: 
  229: 		ait_val_t			dir;		/* BLOB states directory */
  230: 
  231: 		rpc_cli_t			server;		/* BLOB server socket */
  232: 		array_t				*clients;	/* connected blob client sockets */
  233: 
  234: 		TAILQ_HEAD(, tagBLOB)		blobs;		/* registered blob variables list */
  235: 	} 				srv_blob;
  236: } rpc_srv_t;
  237: 
  238: 
  239: /* 
  240:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
  241:  *
  242:  * @arg1 = RPC client
  243:  * @arg2 = RPC packet header
  244:  * @arg3 = input array with values from RPC call execution request
  245:  * return: -1 error or >-1 success execution
  246:  */
  247: typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *);
  248: 
  249: 
  250: /* ----------------------------------------------------------------------- */
  251: 
  252: /* Error support functions */
  253: 
  254: // rpc_GetErrno() Get error code of last operation
  255: int rpc_GetErrno();
  256: // rpc_GetError() Get error text of last operation
  257: const char *rpc_GetError();
  258: // rpc_SetErr() Set error to variables for internal use!!!
  259: void rpc_SetErr(int eno, char *estr, ...);
  260: 
  261: 
  262: 
  263: /*
  264:  * rpc_chkPktSession() - Check RPC session
  265:  *
  266:  * @p = packet session
  267:  * @s = active session
  268:  * return: -1, 1, 2, 3 are errors or 0 ok
  269:  */
  270: int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
  271: /*
  272:  * rpc_addPktSession() - Prepare session into network format
  273:  *
  274:  * @p = packet session
  275:  * @s = host session
  276:  * return: -1 error or 0 ok
  277:  */
  278: int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
  279: /*
  280:  * rpc_register_srvPing() - Register ping service function
  281:  *
  282:  * @srv = RPC server instance
  283:  * return: -1 error or 0 ok
  284:  */
  285: int rpc_register_srvPing(rpc_srv_t * __restrict srv);
  286: /*
  287:  * rpc_register_srvServices() - Register internal service functions
  288:  *
  289:  * @srv = RPC server instance
  290:  * return: -1 error or 0 ok
  291:  */
  292: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
  293: /*
  294:  * rpc_register_blobServices() - Register internal service functions
  295:  *
  296:  * @srv = RPC server instance
  297:  * return: -1 error or 0 ok
  298:  */
  299: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
  300: 
  301: 
  302: /* RPC Server side functions */
  303: 
  304: /*
  305:  * rpc_srv_initServer() - Init & create RPC Server
  306:  *
  307:  * @InstID = Instance for authentication & recognition
  308:  * @concurentClients = Concurent clients at same time to this server
  309:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  310:  * @csHost = Host name or address for bind server, if NULL any address
  311:  * @Port = Port for bind server, if Port == 0 default port is selected
  312:  * @proto = Protocol, if == 0 choose SOCK_STREAM
  313:  * return: NULL == error or !=NULL bind and created RPC server instance
  314:  */
  315: rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, 
  316: 		const char *csHost, unsigned short Port, int proto);
  317: /*
  318:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
  319:  *
  320:  * @psrv = RPC Server instance
  321:  * return: none
  322:  */
  323: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
  324: /*
  325:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
  326:  *
  327:  * @srv = RPC Server instance
  328:  * return: -1 error or 0 ok, infinite loop ...
  329:  */
  330: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
  331: #define rpc_srv_execServer(_srv, _sync)	do { assert((_srv)); \
  332: 						if (!(_srv)->srv_kill) { \
  333: 							pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
  334: 									rpc_srv_loopServer, (_srv)); \
  335: 							if ((_sync)) \
  336: 								pthread_join((_srv)->srv_tid, (void**) (_sync)); \
  337: 							else \
  338: 								pthread_detach((_srv)->srv_tid); \
  339: 						} } while (0)
  340: 
  341: /*
  342:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
  343:  *
  344:  * @srv = RPC server instance
  345:  * @Port = Port for bind server, if Port == 0 default port is selected
  346:  * @diskDir = Disk place for BLOB file objects
  347:  * return: -1 == error or 0 bind and created BLOB server instance
  348:  */
  349: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
  350: /*
  351:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
  352:  *
  353:  * @srv = RPC Server instance
  354:  * return: none
  355:  */
  356: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
  357: /*
  358:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
  359:  *
  360:  * @srv = RPC Server instance
  361:  * return: -1 error or 0 ok, infinite loop ...
  362:  */
  363: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
  364: #define rpc_srv_execBLOBServer(_srv)	do { assert((_srv)); \
  365: 						if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
  366: 							pthread_create(&(_srv)->srv_blob.tid, NULL, \
  367: 									(void*(*)(void*)) \
  368: 									rpc_srv_loopBLOBServer, (_srv)); \
  369: 							pthread_detach((_srv)->srv_blob.tid); \
  370: 						} \
  371: 					} while (0)
  372: 
  373: /*
  374:  * rpc_srv_registerCall() - Register call to RPC server
  375:  *
  376:  * @srv = RPC Server instance
  377:  * @tag = Function tag
  378:  * @funcaddr = Function address
  379:  * return: -1 error, 0 already registered tag or 1 register ok
  380:  */
  381: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
  382: /*
  383:  * rpc_srv_unregisterCall() - Unregister call from RPC server
  384:  *
  385:  * @srv = RPC Server instance
  386:  * @tag = Function tag
  387:  * return: -1 error, 0 not found call, 1 unregister ok
  388:  */
  389: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
  390: /*
  391:  * rpc_srv_getCall()  - Get registered call from RPC server
  392:  *
  393:  * @srv = RPC Server instance
  394:  * @tag = tag for function
  395:  * return: NULL not found call, !=NULL return call
  396:  */
  397: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
  398: /*
  399:  * rpc_srv_execCall() Execute registered call from RPC server
  400:  *
  401:  * @cli = RPC client
  402:  * @rpc = IN RPC call structure
  403:  * @funcname = Execute RPC function
  404:  * @args = IN RPC calling arguments from RPC client
  405:  * return: -1 error, !=-1 ok
  406:  */
  407: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc, 
  408: 		ait_val_t funcname, array_t * __restrict args);
  409: 
  410: 
  411: /*
  412:  * rpc_srv_blobCreate() - Create and map blob to memory region and return object
  413:  *
  414:  * @srv = RPC Server instance
  415:  * @len = BLOB length object
  416:  * @tout = BLOB live timeout in seconds
  417:  * return: NULL error or !=NULL allocated BLOB object
  418:  */
  419: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
  420: /*
  421:  * rpc_srv_blobMap() - Map blob to memory region 
  422:  *
  423:  * @srv = RPC Server instance
  424:  * @blob = Map to this BLOB element
  425:  * return: -1 error or 0 ok
  426:  */
  427: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
  428: /*
  429:  * rpc_srv_blobUnmap() - Unmap blob memory region 
  430:  *
  431:  * @blob = Mapped BLOB element
  432:  * return: none
  433:  */
  434: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
  435: /*
  436:  * rpc_srv_blobFree() - Free blob from disk & memory
  437:  *
  438:  * @srv = RPC Server instance
  439:  * @blob = Mapped BLOB element
  440:  * return: -1 error or 0 ok
  441:  */
  442: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
  443: 
  444: /*
  445:  * rpc_srv_registerBLOB() - Register new BLOB to server
  446:  *
  447:  * @srv = RPC Server instance
  448:  * @len = BLOB length
  449:  * @tout = BLOB live timeout in seconds
  450:  * return: NULL error or new registered BLOB
  451:  */
  452: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
  453: /*
  454:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
  455:  *
  456:  * @srv = RPC Server instance
  457:  * @var = BLOB Variable for unregister
  458:  * return: -1 error, 0 not found call, 1 unregister ok
  459:  */
  460: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
  461: /*
  462:  * rpc_srv_getBLOB() - Get registered BLOB 
  463:  *
  464:  * @srv = RPC Server instance
  465:  * @var = hash for variable
  466:  * return: NULL not found, !=NULL return blob var
  467:  */
  468: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
  469: 
  470: /*
  471:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
  472:  *
  473:  * @cli = Client instance
  474:  * @blob = Mapped BLOB element
  475:  * return: -1 error, 0 ok
  476:  */
  477: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
  478: /*
  479:  * rpc_srv_recvBLOB() - Receive BLOB from client
  480:  *
  481:  * @cli = Client instance
  482:  * @blob = Mapped BLOB element
  483:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
  484:  */
  485: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
  486: 
  487: /* CLIENT part of functions */
  488: 
  489: /*
  490:  * rpc_cli_sendBLOB() - Send BLOB to server
  491:  *
  492:  * @cli = Client instance
  493:  * @var = BLOB variable
  494:  * @data = BLOB data
  495:  * @tout = BLOB live on server timeout in seconds, if =0 default timeout
  496:  * return: -1 error, 0 ok, 1 remote error
  497:  */
  498: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
  499: 		void * __restrict data, int tout);
  500: /*
  501:  * rpc_cli_recvBLOB() - Receive BLOB from server
  502:  *
  503:  * @cli = Client instance
  504:  * @var = BLOB variable
  505:  * @data = BLOB data, must be e_free after use!
  506:  * return: -1 error, 0 ok, 1 remote error
  507:  */
  508: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
  509: /*
  510:  * rpc_cli_delBLOB() - Delete BLOB from server
  511:  *
  512:  * @cli = Client instance
  513:  * @var = BLOB variable
  514:  * return: -1 error, 0 ok, 1 remote error
  515:  */
  516: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
  517: /*
  518:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
  519:  *
  520:  * @cli = Client instance
  521:  * @var = BLOB variable
  522:  * @data = BLOB data, must be e_free after use!
  523:  * return: -1 error, 0 ok, >0 remote error
  524:  */
  525: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
  526: 		void ** __restrict data);
  527: 
  528: 
  529: /* RPC Client side functions */
  530: 
  531: /*
  532:  * rpc_cli_openClient() - Connect to RPC Server
  533:  *
  534:  * @InstID = InstID for RPC session request
  535:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  536:  * @csHost = Host name or IP address for bind server
  537:  * @Port = Port for bind server, if Port == 0 default port is selected
  538:  * @proto = Protocol, if == 0 choose SOCK_STREAM
  539:  * return: NULL == error or !=NULL connection to RPC server established
  540:  */
  541: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, 
  542: 		const char *csHost, unsigned short Port, int proto);
  543: /*
  544:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
  545:  *
  546:  * @cli = RPC Client session
  547:  * return: none
  548:  */
  549: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
  550: /*
  551:  * rpc_pkt_Send() - Send RPC packet
  552:  *
  553:  * @sock = Socket
  554:  * @type = Type of socket
  555:  * @sa = Server address
  556:  * @pkt = RPC packet
  557:  * @len = Length of packet
  558:  * return: -1 error or !=-1 sended bytes
  559:  */
  560: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, 
  561: 		ait_val_t * __restrict pkt, int len);
  562: /*
  563:  * rpc_pkt_Receive() - Receive RPC packet
  564:  *
  565:  * @sock = Socket
  566:  * @type = Type of socket
  567:  * @sa = Server address
  568:  * @pkt = RPC packet
  569:  * return: -1 error or !=-1 sended bytes
  570:  */
  571: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, 
  572: 		ait_val_t * __restrict pkt);
  573: /*
  574:  * rpc_pkt_Request() - Build RPC Request packet
  575:  *
  576:  * @pkt = Packet buffer
  577:  * @sess = RPC session info
  578:  * @tag = Function tag for execution
  579:  * @vars = Function argument array of values, may be NULL
  580:  * @noreply = We not want RPC reply
  581:  * @nocrc = Without CRC calculation
  582:  * return: -1 error or != -1 prepared bytes into packet
  583:  */
  584: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
  585: 		unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
  586: /*
  587:  * rpc_pkt_Replay() - Decode RPC Replay packet
  588:  *
  589:  * @pkt = Packet buffer
  590:  * @sess = RPC session info
  591:  * @tag = Function tag
  592:  * @vars = Function argument array of values, may be NULL
  593:  * @nocrc = Without CRC calculation
  594:  * return: -1 error or != -1 return value from function
  595:  */
  596: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
  597: 		unsigned short tag, array_t ** __restrict vars, int nocrc);
  598: /*
  599:  * rpc_cli_execCall() - Execute RPC call
  600:  *
  601:  * @cli = RPC Client session
  602:  * @noreply = We not want RPC reply
  603:  * @tag = Function tag for execution
  604:  * @in_vars = IN function argument array of values, may be NULL
  605:  * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
  606:  * return: -1 error or != -1 ok result
  607:  */
  608: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, 
  609: 		array_t * __restrict in_vars, array_t ** __restrict out_vars);
  610: /*
  611:  * rpc_cli_freeCall() - Free resouce allocated by RPC call
  612:  *
  613:  * @out_vars = Returned array with variables from RPC call
  614:  * return: none
  615:  */
  616: void rpc_cli_freeCall(array_t ** __restrict out_vars);
  617: /*
  618:  * rpc_cli_ping() - Ping RPC server
  619:  *
  620:  * @cli = connected client
  621:  * return: -1 error or !=-1 ping seq id
  622:  */
  623: int rpc_cli_ping(rpc_cli_t *cli);
  624: 
  625: 
  626: /*
  627:  * rpc_cli_openBLOBClient() - Connect to BLOB Server
  628:  *
  629:  * @rpccli = RPC Client session
  630:  * @Port = Port for bind server, if Port == 0 default port is selected
  631:  * return: NULL == error or !=NULL connection to BLOB server established
  632:  */
  633: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
  634: /*
  635:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
  636:  *
  637:  * @cli = BLOB Client session
  638:  * return: none
  639:  */
  640: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
  641: 
  642: 
  643: #endif

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