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.19 2013/08/23 13:53:15 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) ((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: ait_val_t cli_buf; /* network buffer */
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_Read() - RPC read operation
265: *
266: * @sock = socket
267: * @type = type of socket
268: * @flags = receive flags
269: * @sa = check client address, if you use udp protocol
270: * @buf = buffer
271: * @blen = buffer length
272: * return: -1 error or >-1 readed bytes into buffer
273: */
274: ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa,
275: unsigned char * __restrict buf, size_t blen);
276: /*
277: * rpc_Write() - RPC write operation
278: *
279: * @sock = socket
280: * @type = type of socket
281: * @flags = send flags
282: * @sa = send to client address, if you use udp protocol
283: * @buf = buffer
284: * @blen = buffer length
285: * return: -1 error or >-1 written bytes into buffer
286: */
287: ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa,
288: unsigned char * __restrict buf, size_t blen);
289:
290: /*
291: * rpc_chkPktSession() - Check RPC session
292: *
293: * @p = packet session
294: * @s = active session
295: * return: -1, 1, 2, 3 are errors or 0 ok
296: */
297: int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
298: /*
299: * rpc_addPktSession() - Prepare session into network format
300: *
301: * @p = packet session
302: * @s = host session
303: * return: -1 error or 0 ok
304: */
305: int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
306: /*
307: * rpc_register_srvPing() - Register ping service function
308: *
309: * @srv = RPC server instance
310: * return: -1 error or 0 ok
311: */
312: int rpc_register_srvPing(rpc_srv_t * __restrict srv);
313: /*
314: * rpc_register_srvServices() - Register internal service functions
315: *
316: * @srv = RPC server instance
317: * return: -1 error or 0 ok
318: */
319: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
320: /*
321: * rpc_register_blobServices() - Register internal service functions
322: *
323: * @srv = RPC server instance
324: * return: -1 error or 0 ok
325: */
326: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
327:
328:
329: /* RPC Server side functions */
330:
331: /*
332: * rpc_srv_initServer() - Init & create RPC Server
333: *
334: * @InstID = Instance for authentication & recognition
335: * @concurentClients = Concurent clients at same time to this server
336: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
337: * @csHost = Host name or address for bind server, if NULL any address
338: * @Port = Port for bind server, if Port == 0 default port is selected
339: * @proto = Protocol, if == 0 choose SOCK_STREAM
340: * return: NULL == error or !=NULL bind and created RPC server instance
341: */
342: rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf,
343: const char *csHost, unsigned short Port, int proto);
344: /*
345: * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
346: *
347: * @psrv = RPC Server instance
348: * return: none
349: */
350: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
351: /*
352: * rpc_srv_loopServer() - Execute Main 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_loopServer(rpc_srv_t * __restrict srv);
358: #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \
359: if (!(_srv)->srv_kill) { \
360: pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
361: rpc_srv_loopServer, (_srv)); \
362: if ((_sync)) \
363: pthread_join((_srv)->srv_tid, (void**) (_sync)); \
364: else \
365: pthread_detach((_srv)->srv_tid); \
366: } } while (0)
367:
368: /*
369: * rpc_srv_initBLOBServer() - Init & create BLOB Server
370: *
371: * @srv = RPC server instance
372: * @Port = Port for bind server, if Port == 0 default port is selected
373: * @diskDir = Disk place for BLOB file objects
374: * return: -1 == error or 0 bind and created BLOB server instance
375: */
376: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
377: /*
378: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
379: *
380: * @srv = RPC Server instance
381: * return: none
382: */
383: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
384: /*
385: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
386: *
387: * @srv = RPC Server instance
388: * return: -1 error or 0 ok, infinite loop ...
389: */
390: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
391: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \
392: if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
393: pthread_create(&(_srv)->srv_blob.tid, NULL, \
394: (void*(*)(void*)) \
395: rpc_srv_loopBLOBServer, (_srv)); \
396: pthread_detach((_srv)->srv_blob.tid); \
397: } \
398: } while (0)
399:
400: /*
401: * rpc_srv_registerCall() - Register call to RPC server
402: *
403: * @srv = RPC Server instance
404: * @tag = Function tag
405: * @funcaddr = Function address
406: * return: -1 error, 0 already registered tag or 1 register ok
407: */
408: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
409: /*
410: * rpc_srv_unregisterCall() - Unregister call from RPC server
411: *
412: * @srv = RPC Server instance
413: * @tag = Function tag
414: * return: -1 error, 0 not found call, 1 unregister ok
415: */
416: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
417: /*
418: * rpc_srv_getCall() - Get registered call from RPC server
419: *
420: * @srv = RPC Server instance
421: * @tag = tag for function
422: * return: NULL not found call, !=NULL return call
423: */
424: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
425: /*
426: * rpc_srv_execCall() Execute registered call from RPC server
427: *
428: * @cli = RPC client
429: * @rpc = IN RPC call structure
430: * @funcname = Execute RPC function
431: * @args = IN RPC calling arguments from RPC client
432: * return: -1 error, !=-1 ok
433: */
434: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc,
435: ait_val_t funcname, array_t * __restrict args);
436:
437:
438: /*
439: * rpc_srv_blobCreate() - Create and map blob to memory region and return object
440: *
441: * @srv = RPC Server instance
442: * @len = BLOB length object
443: * @tout = BLOB live timeout in seconds
444: * return: NULL error or !=NULL allocated BLOB object
445: */
446: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
447: /*
448: * rpc_srv_blobMap() - Map blob to memory region
449: *
450: * @srv = RPC Server instance
451: * @blob = Map to this BLOB element
452: * return: -1 error or 0 ok
453: */
454: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
455: /*
456: * rpc_srv_blobUnmap() - Unmap blob memory region
457: *
458: * @blob = Mapped BLOB element
459: * return: none
460: */
461: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
462: /*
463: * rpc_srv_blobFree() - Free blob from disk & memory
464: *
465: * @srv = RPC Server instance
466: * @blob = Mapped BLOB element
467: * return: -1 error or 0 ok
468: */
469: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
470:
471: /*
472: * rpc_srv_registerBLOB() - Register new BLOB to server
473: *
474: * @srv = RPC Server instance
475: * @len = BLOB length
476: * @tout = BLOB live timeout in seconds
477: * return: NULL error or new registered BLOB
478: */
479: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
480: /*
481: * rpc_srv_unregisterBLOB() - Unregister BLOB from server
482: *
483: * @srv = RPC Server instance
484: * @var = BLOB Variable for unregister
485: * return: -1 error, 0 not found call, 1 unregister ok
486: */
487: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
488: /*
489: * rpc_srv_getBLOB() - Get registered BLOB
490: *
491: * @srv = RPC Server instance
492: * @var = hash for variable
493: * return: NULL not found, !=NULL return blob var
494: */
495: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
496:
497: /*
498: * rpc_srv_sendBLOB() - Send mapped BLOB to client
499: *
500: * @cli = Client instance
501: * @blob = Mapped BLOB element
502: * return: -1 error, 0 ok
503: */
504: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
505: /*
506: * rpc_srv_recvBLOB() - Receive BLOB from client
507: *
508: * @cli = Client instance
509: * @blob = Mapped BLOB element
510: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
511: */
512: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
513:
514: /* CLIENT part of functions */
515:
516: /*
517: * rpc_cli_sendBLOB() - Send BLOB to server
518: *
519: * @cli = Client instance
520: * @var = BLOB variable
521: * @data = BLOB data
522: * @tout = BLOB live on server timeout in seconds, if =0 default timeout
523: * return: -1 error, 0 ok, 1 remote error
524: */
525: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
526: void * __restrict data, int tout);
527: /*
528: * rpc_cli_recvBLOB() - Receive BLOB from server
529: *
530: * @cli = Client instance
531: * @var = BLOB variable
532: * @data = BLOB data, must be e_free after use!
533: * return: -1 error, 0 ok, 1 remote error
534: */
535: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
536: /*
537: * rpc_cli_delBLOB() - Delete BLOB from server
538: *
539: * @cli = Client instance
540: * @var = BLOB variable
541: * return: -1 error, 0 ok, 1 remote error
542: */
543: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
544: /*
545: * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
546: *
547: * @cli = Client instance
548: * @var = BLOB variable
549: * @data = BLOB data, must be e_free after use!
550: * return: -1 error, 0 ok, >0 remote error
551: */
552: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
553: void ** __restrict data);
554:
555:
556: /* RPC Client side functions */
557:
558: /*
559: * rpc_cli_openClient() - Connect to RPC Server
560: *
561: * @InstID = InstID for RPC session request
562: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
563: * @csHost = Host name or IP address for bind server
564: * @Port = Port for bind server, if Port == 0 default port is selected
565: * @proto = Protocol, if == 0 choose SOCK_STREAM
566: * return: NULL == error or !=NULL connection to RPC server established
567: */
568: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf,
569: const char *csHost, unsigned short Port, int proto);
570: /*
571: * rpc_cli_closeClient() - Close connection to RPC server and free resources
572: *
573: * @cli = RPC Client session
574: * return: none
575: */
576: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
577: /*
578: * rpc_pkt_Send() - Send RPC packet
579: *
580: * @sock = Socket
581: * @type = Type of socket
582: * @sa = Server address
583: * @pkt = RPC packet
584: * @len = Length of packet
585: * return: -1 error or !=-1 sended bytes
586: */
587: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa,
588: ait_val_t * __restrict pkt, int len);
589: /*
590: * rpc_pkt_Receive() - Receive RPC packet
591: *
592: * @sock = Socket
593: * @type = Type of socket
594: * @sa = Server address
595: * @pkt = RPC packet
596: * return: -1 error or !=-1 sended bytes
597: */
598: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa,
599: ait_val_t * __restrict pkt);
600: /*
601: * rpc_pkt_Request() - Build RPC Request packet
602: *
603: * @pkt = Packet buffer
604: * @sess = RPC session info
605: * @tag = Function tag for execution
606: * @vars = Function argument array of values, may be NULL
607: * @noreply = We not want RPC reply
608: * @nocrc = Without CRC calculation
609: * return: -1 error or != -1 prepared bytes into packet
610: */
611: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
612: unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
613: /*
614: * rpc_pkt_Replay() - Decode RPC Replay packet
615: *
616: * @pkt = Packet buffer
617: * @sess = RPC session info
618: * @tag = Function tag
619: * @vars = Function argument array of values, may be NULL
620: * @nocrc = Without CRC calculation
621: * return: -1 error or != -1 return value from function
622: */
623: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
624: unsigned short tag, array_t ** __restrict vars, int nocrc);
625: /*
626: * rpc_cli_execCall() - Execute RPC call
627: *
628: * @cli = RPC Client session
629: * @noreply = We not want RPC reply
630: * @tag = Function tag for execution
631: * @in_vars = IN function argument array of values, may be NULL
632: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
633: * return: -1 error or != -1 ok result
634: */
635: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,
636: array_t * __restrict in_vars, array_t ** __restrict out_vars);
637: /*
638: * rpc_cli_freeCall() - Free resouce allocated by RPC call
639: *
640: * @out_vars = Returned array with variables from RPC call
641: * return: none
642: */
643: void rpc_cli_freeCall(array_t ** __restrict out_vars);
644: /*
645: * rpc_cli_ping() - Ping RPC server
646: *
647: * @cli = connected client
648: * return: -1 error or !=-1 ping seq id
649: */
650: int rpc_cli_ping(rpc_cli_t *cli);
651:
652:
653: /*
654: * rpc_cli_openBLOBClient() - Connect to BLOB Server
655: *
656: * @rpccli = RPC Client session
657: * @Port = Port for bind server, if Port == 0 default port is selected
658: * return: NULL == error or !=NULL connection to BLOB server established
659: */
660: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
661: /*
662: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
663: *
664: * @cli = BLOB Client session
665: * return: none
666: */
667: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
668:
669:
670: #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