File:
[ELWIX - Embedded LightWeight unIX -] /
libaitrpc /
inc /
aitrpc.h
Revision
1.20:
download - view:
text,
annotated -
select for diffs -
revision graph
Thu Sep 5 00:43:04 2013 UTC (10 years, 9 months ago) by
misho
Branches:
MAIN
CVS tags:
rpc6_6,
rpc6_5,
rpc6_4,
rpc6_3,
RPC6_5,
RPC6_4,
RPC6_3,
RPC6_2,
HEAD
version 6.2
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.20 2013/09/05 00:43:04 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:
369: /*
370: * rpc_srv_initBLOBServer() - Init & create BLOB Server
371: *
372: * @srv = RPC server instance
373: * @Port = Port for bind server, if Port == 0 default port is selected
374: * @diskDir = Disk place for BLOB file objects
375: * return: -1 == error or 0 bind and created BLOB server instance
376: */
377: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
378: /*
379: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
380: *
381: * @srv = RPC Server instance
382: * return: none
383: */
384: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
385: /*
386: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
387: *
388: * @srv = RPC Server instance
389: * return: -1 error or 0 ok, infinite loop ...
390: */
391: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
392: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \
393: if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
394: pthread_create(&(_srv)->srv_blob.tid, NULL, \
395: (void*(*)(void*)) \
396: rpc_srv_loopBLOBServer, (_srv)); \
397: pthread_detach((_srv)->srv_blob.tid); \
398: } \
399: } while (0)
400:
401: /*
402: * rpc_srv_registerCall() - Register call to RPC server
403: *
404: * @srv = RPC Server instance
405: * @tag = Function tag
406: * @funcaddr = Function address
407: * return: -1 error, 0 already registered tag or 1 register ok
408: */
409: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
410: /*
411: * rpc_srv_unregisterCall() - Unregister call from RPC server
412: *
413: * @srv = RPC Server instance
414: * @tag = Function tag
415: * return: -1 error, 0 not found call, 1 unregister ok
416: */
417: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
418: /*
419: * rpc_srv_getCall() - Get registered call from RPC server
420: *
421: * @srv = RPC Server instance
422: * @tag = tag for function
423: * return: NULL not found call, !=NULL return call
424: */
425: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
426: /*
427: * rpc_srv_execCall() Execute registered call from RPC server
428: *
429: * @cli = RPC client
430: * @rpc = IN RPC call structure
431: * @funcname = Execute RPC function
432: * @args = IN RPC calling arguments from RPC client
433: * return: -1 error, !=-1 ok
434: */
435: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc,
436: ait_val_t funcname, array_t * __restrict args);
437:
438:
439: /*
440: * rpc_srv_blobCreate() - Create and map blob to memory region and return object
441: *
442: * @srv = RPC Server instance
443: * @len = BLOB length object
444: * @tout = BLOB live timeout in seconds
445: * return: NULL error or !=NULL allocated BLOB object
446: */
447: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
448: /*
449: * rpc_srv_blobMap() - Map blob to memory region
450: *
451: * @srv = RPC Server instance
452: * @blob = Map to this BLOB element
453: * return: -1 error or 0 ok
454: */
455: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
456: /*
457: * rpc_srv_blobUnmap() - Unmap blob memory region
458: *
459: * @blob = Mapped BLOB element
460: * return: none
461: */
462: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
463: /*
464: * rpc_srv_blobFree() - Free blob from disk & memory
465: *
466: * @srv = RPC Server instance
467: * @blob = Mapped BLOB element
468: * return: -1 error or 0 ok
469: */
470: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
471:
472: /*
473: * rpc_srv_registerBLOB() - Register new BLOB to server
474: *
475: * @srv = RPC Server instance
476: * @len = BLOB length
477: * @tout = BLOB live timeout in seconds
478: * return: NULL error or new registered BLOB
479: */
480: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
481: /*
482: * rpc_srv_unregisterBLOB() - Unregister BLOB from server
483: *
484: * @srv = RPC Server instance
485: * @var = BLOB Variable for unregister
486: * return: -1 error, 0 not found call, 1 unregister ok
487: */
488: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
489: /*
490: * rpc_srv_getBLOB() - Get registered BLOB
491: *
492: * @srv = RPC Server instance
493: * @var = hash for variable
494: * return: NULL not found, !=NULL return blob var
495: */
496: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
497:
498: /*
499: * rpc_srv_sendBLOB() - Send mapped BLOB to client
500: *
501: * @cli = Client instance
502: * @blob = Mapped BLOB element
503: * return: -1 error, 0 ok
504: */
505: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
506: /*
507: * rpc_srv_recvBLOB() - Receive BLOB from client
508: *
509: * @cli = Client instance
510: * @blob = Mapped BLOB element
511: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
512: */
513: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
514:
515: /* CLIENT part of functions */
516:
517: /*
518: * rpc_cli_sendBLOB() - Send BLOB to server
519: *
520: * @cli = Client instance
521: * @var = BLOB variable
522: * @data = BLOB data
523: * @tout = BLOB live on server timeout in seconds, if =0 default timeout
524: * return: -1 error, 0 ok, 1 remote error
525: */
526: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
527: void * __restrict data, int tout);
528: /*
529: * rpc_cli_recvBLOB() - Receive BLOB from server
530: *
531: * @cli = Client instance
532: * @var = BLOB variable
533: * @data = BLOB data, must be e_free after use!
534: * return: -1 error, 0 ok, 1 remote error
535: */
536: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
537: /*
538: * rpc_cli_delBLOB() - Delete BLOB from server
539: *
540: * @cli = Client instance
541: * @var = BLOB variable
542: * return: -1 error, 0 ok, 1 remote error
543: */
544: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
545: /*
546: * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
547: *
548: * @cli = Client instance
549: * @var = BLOB variable
550: * @data = BLOB data, must be e_free after use!
551: * return: -1 error, 0 ok, >0 remote error
552: */
553: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
554: void ** __restrict data);
555:
556:
557: /* RPC Client side functions */
558:
559: /*
560: * rpc_cli_openClient() - Connect to RPC Server
561: *
562: * @InstID = InstID for RPC session request
563: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
564: * @csHost = Host name or IP address for bind server
565: * @Port = Port for bind server, if Port == 0 default port is selected
566: * @proto = Protocol, if == 0 choose SOCK_STREAM
567: * return: NULL == error or !=NULL connection to RPC server established
568: */
569: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf,
570: const char *csHost, unsigned short Port, int proto);
571: /*
572: * rpc_cli_closeClient() - Close connection to RPC server and free resources
573: *
574: * @cli = RPC Client session
575: * return: none
576: */
577: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
578: /*
579: * rpc_pkt_Send() - Send RPC packet
580: *
581: * @sock = Socket
582: * @type = Type of socket
583: * @sa = Server address
584: * @pkt = RPC packet
585: * @len = Length of packet
586: * return: -1 error or !=-1 sended bytes
587: */
588: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa,
589: ait_val_t * __restrict pkt, int len);
590: /*
591: * rpc_pkt_Receive() - Receive RPC packet
592: *
593: * @sock = Socket
594: * @type = Type of socket
595: * @sa = Server address
596: * @pkt = RPC packet
597: * return: -1 error or !=-1 sended bytes
598: */
599: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa,
600: ait_val_t * __restrict pkt);
601: /*
602: * rpc_pkt_Request() - Build RPC Request packet
603: *
604: * @pkt = Packet buffer
605: * @sess = RPC session info
606: * @tag = Function tag for execution
607: * @vars = Function argument array of values, may be NULL
608: * @noreply = We not want RPC reply
609: * @nocrc = Without CRC calculation
610: * return: -1 error or != -1 prepared bytes into packet
611: */
612: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
613: unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
614: /*
615: * rpc_pkt_Replay() - Decode RPC Replay packet
616: *
617: * @pkt = Packet buffer
618: * @sess = RPC session info
619: * @tag = Function tag
620: * @vars = Function argument array of values, may be NULL
621: * @nocrc = Without CRC calculation
622: * return: -1 error or != -1 return value from function
623: */
624: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
625: unsigned short tag, array_t ** __restrict vars, int nocrc);
626: /*
627: * rpc_cli_execCall() - Execute RPC call
628: *
629: * @cli = RPC Client session
630: * @noreply = We not want RPC reply
631: * @tag = Function tag for execution
632: * @in_vars = IN function argument array of values, may be NULL
633: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
634: * return: -1 error or != -1 ok result
635: */
636: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,
637: array_t * __restrict in_vars, array_t ** __restrict out_vars);
638: /*
639: * rpc_cli_freeCall() - Free resouce allocated by RPC call
640: *
641: * @out_vars = Returned array with variables from RPC call
642: * return: none
643: */
644: void rpc_cli_freeCall(array_t ** __restrict out_vars);
645: /*
646: * rpc_cli_ping() - Ping RPC server
647: *
648: * @cli = connected client
649: * return: -1 error or !=-1 ping seq id
650: */
651: int rpc_cli_ping(rpc_cli_t *cli);
652:
653:
654: /*
655: * rpc_cli_openBLOBClient() - Connect to BLOB Server
656: *
657: * @rpccli = RPC Client session
658: * @Port = Port for bind server, if Port == 0 default port is selected
659: * return: NULL == error or !=NULL connection to BLOB server established
660: */
661: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
662: /*
663: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
664: *
665: * @cli = BLOB Client session
666: * return: none
667: */
668: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
669:
670:
671: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitrpc.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc