File:  [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc / aitrpc.h
Revision 1.12.4.2: download - view: text, annotated - select for diffs - revision graph
Thu Mar 7 23:03:03 2013 UTC (11 years, 3 months ago) by misho
Branches: rpc5_0
Diff to: branchpoint 1.12: preferred, unified
shuffle RPC client code and create new API calls
fine tuning on buffer parsing

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

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