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.27.2.1 2015/06/29 22:29:25 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 - 2015
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 9
66: #define RPC_DEFPORT 2611
67:
68: /* Additional ELWIX RPC supporting protocols */
69: #ifndef SOCK_STREAM
70: #define SOCK_STREAM 1 /* stream socket */
71: #endif
72: #ifndef SOCK_DGRAM
73: #define SOCK_DGRAM 2 /* datagram socket */
74: #endif
75: #ifndef SOCK_RAW
76: #define SOCK_RAW 3 /* raw-protocol interface */
77: #endif
78: #define SOCK_BPF 4 /* ethernet interface */
79: #define SOCK_EXT 5 /* bi-directional pipe interface */
80:
81: /* RPC call request flags */
82:
83: #define RPC_REPLY 0x0
84: #define RPC_NOREPLY 0x1
85:
86: /* RPC call I/O direction */
87:
88: #define RPC_REQ 0x0
89: #define RPC_ACK 0x1
90:
91: /* RPC builtin registed calls */
92:
93: #define CALL_TAG_MAX 65535
94:
95: #define CALL_SRVPING 65534
96:
97: #define CALL_SRVSHUTDOWN 65533
98: #define CALL_SRVCLIENTS 65532
99: #define CALL_SRVCALLS 65531
100: #define CALL_SRVSESSIONS 65530
101:
102: #define CALL_BLOBSHUTDOWN 65529
103: #define CALL_BLOBCLIENTS 65528
104: #define CALL_BLOBVARS 65527
105:
106: /* RPC signals */
107: #define SIGFBLOB 54
108:
109: /* RPC types */
110:
111: typedef enum {
112: ok, error, no, /* for blob reply */
113: get, set, unset /* for blob request */
114: } blob_cmd_type_t;
115:
116:
117: #define RPC_CALLBACK_CHECK_INPUT(x) do { \
118: assert((x)); \
119: if (!(x)) { \
120: rpc_SetErr(EINVAL, \
121: "Invalid callback parameters ..."); \
122: return -1; \
123: } \
124: } while (0)
125:
126:
127: /* RPC session identification */
128:
129: typedef struct {
130: #if BYTE_ORDER == LITTLE_ENDIAN
131: uint16_t sess_instance:8;
132: uint16_t sess_version:8;
133: #endif
134: #if BYTE_ORDER == BIG_ENDIAN
135: uint16_t sess_version:8;
136: uint16_t sess_instance:8;
137: #endif
138: } __packed rpc_sess_t; /* size == 2 bytes */
139:
140:
141: /* Server managment RPC functions ... */
142:
143: /* Network RPC packet - Client request */
144:
145: struct tagRPCCall {
146: rpc_sess_t call_session;
147:
148: uint32_t call_len;
149: uint32_t call_seq;
150: uint16_t call_crc;
151:
152: union {
153: struct {
154: uint64_t flags;
155: } call_req;
156: struct {
157: int32_t ret;
158: int32_t eno;
159: } call_rep;
160: };
161:
162: uint8_t call_io;
163: uint16_t call_tag;
164: uint8_t call_argc;
165: ait_val_t call_argv[0];
166: } __packed; /* size == 20 bytes */
167: #define RPC_CHK_NOREPLY(x) (ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY)
168: #define RPC_SET_ERRNO(x, _v) ((x)->call_rep.eno = htonl((_v)))
169:
170: /* Network BLOB packet - Header */
171:
172: struct tagBLOBHdr {
173: rpc_sess_t hdr_session;
174: uint8_t hdr_cmd;
175: uint32_t hdr_var;
176: uint32_t hdr_len;
177: uint32_t hdr_ret;
178: uint8_t hdr_pad;
179: } __packed; /* size == 16 bytes */
180:
181: /* Network RPC client & server elements */
182:
183: /* RPC function registration element! */
184: typedef struct tagRPCFunc {
185: ait_val_t func_name;
186:
187: void *func_parent;
188:
189: SLIST_ENTRY(tagRPCFunc) func_next;
190: AVL_ENTRY(tagRPCFunc) func_node;
191: } rpc_func_t;
192: #define RPC_FUNC_SERVER(x) ((rpc_srv_t*) (x)->func_parent)
193:
194: /* Tree root node */
195: typedef struct tagRPCFuncs {
196: pthread_mutex_t mtx;
197:
198: struct tagRPCFunc *slh_first;
199: struct tagRPCFunc *avlh_root;
200: } rpc_funcs_t;
201: #define RPC_FUNCS_LOCK(x) pthread_mutex_lock(&(x)->mtx)
202: #define RPC_FUNCS_UNLOCK(x) pthread_mutex_unlock(&(x)->mtx)
203: #define RPC_FUNCS_ISEMPTY(x) AVL_EMPTY((x))
204:
205:
206: /* BLOB register element */
207: typedef struct tagBLOB {
208: uint32_t blob_var; /* BLOB id */
209:
210: size_t blob_len; /* size of allocated BLOB data */
211: void *blob_data; /* mapped BLOB data */
212:
213: TAILQ_ENTRY(tagBLOB) blob_node;
214: } rpc_blob_t;
215:
216:
217: typedef struct {
218: int cli_id; /* slot id */
219: int cli_sock; /* socket fd */
220: sockaddr_t cli_sa; /* host address */
221: ait_val_t cli_buf; /* network buffer */
222:
223: array_t *cli_vars; /* function return variables */
224:
225: void *cli_parent; /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
226: } rpc_cli_t;
227: #define RPC_RETVARS(x) ((x)->cli_vars)
228: #define RPC_SRV_SERVER(x) ((rpc_srv_t*) (x)->cli_parent)
229: #define RPC_CLI_SESSION(x) ((rpc_sess_t*) (x)->cli_parent)
230:
231: typedef struct {
232: rpc_sess_t srv_session; /* RPC session registration info */
233: int srv_netbuf; /* size of network buffer */
234: int srv_proto; /* Server protocol */
235:
236: pthread_t srv_tid; /* RPC exec pthread */
237: sched_root_task_t *srv_root; /* RPC server scheduler */
238: intptr_t srv_kill; /* Scheduler condition variable */
239:
240: rpc_cli_t srv_server; /* RPC server socket */
241: array_t *srv_clients; /* connected rpc client sockets */
242:
243: rpc_funcs_t srv_funcs; /* RPC functions */
244:
245: struct {
246: pthread_t tid; /* BLOB exec pthread */
247: sched_root_task_t *root; /* BLOB server scheduler */
248: intptr_t kill; /* BLOB server state: ==0 disable | !=0 enable */
249:
250: ait_val_t dir; /* BLOB states directory */
251:
252: rpc_cli_t server; /* BLOB server socket */
253: array_t *clients; /* connected blob client sockets */
254:
255: TAILQ_HEAD(, tagBLOB) blobs; /* registered blob variables list */
256: } srv_blob;
257: } rpc_srv_t;
258:
259:
260: /*
261: * (*rpc_callback_t)() - Callback type definition for RPC call in server process
262: *
263: * @arg1 = RPC client
264: * @arg2 = RPC packet header
265: * @arg3 = input array with values from RPC call execution request
266: * return: -1 error or >-1 success execution
267: */
268: typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *);
269:
270: #define RPC_CALL_DEFINE(x) int (x)(rpc_cli_t*, struct tagRPCCall*, array_t*)
271: #define RPC_CALL_ARGS(arg1, arg2, arg3) rpc_cli_t* arg1, struct tagRPCCall* arg2, array_t* arg3
272: #define RPC_CALL_STDARGS RPC_CALL_ARGS(cli, rpc, iv)
273:
274:
275: /* ----------------------------------------------------------------------- */
276:
277: /* Error support functions */
278:
279: // rpc_GetErrno() Get error code of last operation
280: int rpc_GetErrno();
281: // rpc_GetError() Get error text of last operation
282: const char *rpc_GetError();
283: // rpc_SetErr() Set error to variables for internal use!!!
284: void rpc_SetErr(int eno, char *estr, ...);
285:
286:
287:
288: /*
289: * rpc_Read() - RPC read operation
290: *
291: * @sock = socket
292: * @type = type of socket
293: * @flags = receive flags
294: * @sa = check client address, if you use udp protocol
295: * @pkt = RPC packet
296: * return: -1 error, 0 EOF or or >0 readed bytes into buffer
297: */
298: ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa,
299: ait_val_t * __restrict pkt);
300: /*
301: * rpc_Write() - RPC write operation
302: *
303: * @sock = socket
304: * @type = type of socket
305: * @flags = send flags
306: * @sa = send to client address, if you use udp protocol
307: * @pkt = RPC packet
308: * @blen = write length
309: * return: -1 error, 0 EOF or >0 written bytes into buffer
310: */
311: ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa,
312: ait_val_t * __restrict pkt, size_t blen);
313:
314: /*
315: * rpc_pktFreeSpace() - Get free space for payload into RPC packet
316: *
317: * @c = RPC client
318: * return: remains free bytes from packet
319: */
320: size_t rpc_pktFreeSpace(rpc_cli_t * __restrict c);
321: /*
322: * rpc_chkPktSession() - Check RPC session
323: *
324: * @p = packet session
325: * @s = active session
326: * return: -1, 1, 2, 3 are errors or 0 ok
327: */
328: int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
329: /*
330: * rpc_addPktSession() - Prepare session into network format
331: *
332: * @p = packet session
333: * @s = host session
334: * return: -1 error or 0 ok
335: */
336: int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
337: /*
338: * rpc_register_srvPing() - Register ping service function
339: *
340: * @srv = RPC server instance
341: * return: -1 error or 0 ok
342: */
343: int rpc_register_srvPing(rpc_srv_t * __restrict srv);
344: /*
345: * rpc_register_srvServices() - Register internal service functions
346: *
347: * @srv = RPC server instance
348: * return: -1 error or 0 ok
349: */
350: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
351: /*
352: * rpc_register_blobServices() - Register internal service functions
353: *
354: * @srv = RPC server instance
355: * return: -1 error or 0 ok
356: */
357: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
358:
359:
360: /* RPC Server side functions */
361:
362: /*
363: * rpc_srv_initServer() - Init & create RPC Server
364: *
365: * @InstID = Instance for authentication & recognition
366: * @concurentClients = Concurent clients at same time to this server
367: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
368: * @csHost = Host name or address for bind server, if NULL any address
369: * @Port = Port for bind server, if Port == 0 default port is selected
370: * @proto = Protocol, if == 0 choose SOCK_STREAM
371: * return: NULL == error or !=NULL bind and created RPC server instance
372: */
373: rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf,
374: const char *csHost, unsigned short Port, int proto);
375: /*
376: * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
377: *
378: * @psrv = RPC Server instance
379: * return: none
380: */
381: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
382: /*
383: * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
384: *
385: * @srv = RPC Server instance
386: * return: -1 error or 0 ok, infinite loop ...
387: */
388: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
389: #define rpc_srv_execServer(_srv, _sync) \
390: do { assert((_srv)); \
391: if (!(_srv)->srv_kill) { \
392: pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
393: rpc_srv_loopServer, (_srv)); \
394: if ((_sync)) \
395: pthread_join((_srv)->srv_tid, (void**) (_sync)); \
396: else \
397: pthread_detach((_srv)->srv_tid); \
398: } } while (0)
399: #define rpc_srv_killServer(_srv) \
400: (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1)
401:
402: /*
403: * rpc_srv_initBLOBServer() - Init & create BLOB Server
404: *
405: * @srv = RPC server instance
406: * @Port = Port for bind server, if Port == 0 default port is selected
407: * @diskDir = Disk place for BLOB file objects
408: * return: -1 == error or 0 bind and created BLOB server instance
409: */
410: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
411: /*
412: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
413: *
414: * @srv = RPC Server instance
415: * return: none
416: */
417: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
418: /*
419: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
420: *
421: * @srv = RPC Server instance
422: * return: -1 error or 0 ok, infinite loop ...
423: */
424: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
425: #define rpc_srv_execBLOBServer(_srv) \
426: do { assert((_srv)); \
427: if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
428: pthread_create(&(_srv)->srv_blob.tid, NULL, \
429: (void*(*)(void*)) rpc_srv_loopBLOBServer, (_srv)); \
430: pthread_detach((_srv)->srv_blob.tid); \
431: } \
432: } while (0)
433:
434: /*
435: * rpc_srv_initServer2() - Init & create layer2 RPC Server
436: *
437: * @InstID = Instance for authentication & recognition
438: * @concurentClients = Concurent clients at same time to this server
439: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
440: * @csIface = Interface name for bind server, if NULL first interface on host
441: * return: NULL == error or !=NULL bind and created RPC server instance
442: */
443: rpc_srv_t *rpc_srv_initServer2(u_char InstID, int concurentClients, int netBuf,
444: const char *csIface);
445:
446: /*
447: * rpc_srv_initServerExt() - Init & create pipe RPC Server
448: *
449: * @InstID = Instance for authentication & recognition
450: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
451: * @fd = File descriptor
452: * return: NULL == error or !=NULL bind and created RPC server instance
453: */
454: rpc_srv_t *rpc_srv_initServerExt(u_char InstID, int netBuf, int fd);
455:
456: /*
457: * rpc_srv_registerCall() - Register call to RPC server
458: *
459: * @srv = RPC Server instance
460: * @tag = Function tag
461: * @funcaddr = Function address
462: * return: -1 error, 0 already registered tag or 1 register ok
463: */
464: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
465: /*
466: * rpc_srv_unregisterCall() - Unregister call from RPC server
467: *
468: * @srv = RPC Server instance
469: * @tag = Function tag
470: * return: -1 error, 0 not found call, 1 unregister ok
471: */
472: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
473: /*
474: * rpc_srv_getCall() - Get registered call from RPC server
475: *
476: * @srv = RPC Server instance
477: * @tag = tag for function
478: * return: NULL not found call, !=NULL return call
479: */
480: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
481: /*
482: * rpc_srv_execCall() Execute registered call from RPC server
483: *
484: * @cli = RPC client
485: * @rpc = IN RPC call structure
486: * @funcname = Execute RPC function
487: * @args = IN RPC calling arguments from RPC client
488: * return: -1 error, !=-1 ok
489: */
490: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc,
491: ait_val_t funcname, array_t * __restrict args);
492:
493:
494: /*
495: * rpc_srv_blobCreate() - Create and map blob to memory region and return object
496: *
497: * @srv = RPC Server instance
498: * @len = BLOB length object
499: * @tout = BLOB live timeout in seconds
500: * return: NULL error or !=NULL allocated BLOB object
501: */
502: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
503: /*
504: * rpc_srv_blobMap() - Map blob to memory region
505: *
506: * @srv = RPC Server instance
507: * @blob = Map to this BLOB element
508: * return: -1 error or 0 ok
509: */
510: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
511: /*
512: * rpc_srv_blobUnmap() - Unmap blob memory region
513: *
514: * @blob = Mapped BLOB element
515: * return: none
516: */
517: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
518: /*
519: * rpc_srv_blobFree() - Free blob from disk & memory
520: *
521: * @srv = RPC Server instance
522: * @blob = Mapped BLOB element
523: * return: -1 error or 0 ok
524: */
525: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
526:
527: /*
528: * rpc_srv_registerBLOB() - Register new BLOB to server
529: *
530: * @srv = RPC Server instance
531: * @len = BLOB length
532: * @tout = BLOB live timeout in seconds
533: * return: NULL error or new registered BLOB
534: */
535: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
536: /*
537: * rpc_srv_unregisterBLOB() - Unregister BLOB from server
538: *
539: * @srv = RPC Server instance
540: * @var = BLOB Variable for unregister
541: * return: -1 error, 0 not found call, 1 unregister ok
542: */
543: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
544: /*
545: * rpc_srv_getBLOB() - Get registered BLOB
546: *
547: * @srv = RPC Server instance
548: * @var = hash for variable
549: * return: NULL not found, !=NULL return blob var
550: */
551: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
552:
553: /*
554: * rpc_srv_sendBLOB() - Send mapped BLOB to client
555: *
556: * @cli = Client instance
557: * @blob = Mapped BLOB element
558: * return: -1 error, 0 ok
559: */
560: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
561: /*
562: * rpc_srv_recvBLOB() - Receive BLOB from client
563: *
564: * @cli = Client instance
565: * @blob = Mapped BLOB element
566: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
567: */
568: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
569:
570: /* CLIENT part of functions */
571:
572: /*
573: * rpc_cli_sendBLOB() - Send BLOB to server
574: *
575: * @cli = Client instance
576: * @var = BLOB variable
577: * @data = BLOB data
578: * @tout = BLOB live on server timeout in seconds, if =0 default timeout
579: * return: -1 error, 0 ok, 1 remote error
580: */
581: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
582: void * __restrict data, int tout);
583: /*
584: * rpc_cli_recvBLOB() - Receive BLOB from server
585: *
586: * @cli = Client instance
587: * @var = BLOB variable
588: * @data = BLOB data, must be e_free after use!
589: * return: -1 error, 0 ok, 1 remote error
590: */
591: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
592: /*
593: * rpc_cli_delBLOB() - Delete BLOB from server
594: *
595: * @cli = Client instance
596: * @var = BLOB variable
597: * return: -1 error, 0 ok, 1 remote error
598: */
599: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
600: /*
601: * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
602: *
603: * @cli = Client instance
604: * @var = BLOB variable
605: * @data = BLOB data, must be e_free after use!
606: * return: -1 error, 0 ok, >0 remote error
607: */
608: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
609: void ** __restrict data);
610:
611:
612: /* RPC Client side functions */
613:
614: /*
615: * rpc_cli_openClient() - Connect to RPC Server
616: *
617: * @InstID = InstID for RPC session request
618: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
619: * @csHost = Host name or IP address for bind server
620: * @Port = Port for bind server, if Port == 0 default port is selected
621: * @proto = Protocol, if == 0 choose SOCK_STREAM
622: * return: NULL == error or !=NULL connection to RPC server established
623: */
624: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf,
625: const char *csHost, unsigned short Port, int proto);
626: /*
627: * rpc_cli_reconnectClient() - Reconnecting client to RPC server
628: *
629: * @cli = RPC Client session
630: * return: -1 error or 0 ok
631: */
632: int rpc_cli_reconnectClient(rpc_cli_t * __restrict cli);
633: /*
634: * rpc_cli_closeClient() - Close connection to RPC server and free resources
635: *
636: * @cli = RPC Client session
637: * return: none
638: */
639: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
640: /*
641: * rpc_pkt_Send() - Send RPC packet
642: *
643: * @sock = Socket
644: * @type = Type of socket
645: * @sa = Server address
646: * @pkt = RPC packet
647: * @len = Length of packet
648: * return: -1 error, 0 EOF or >0 sended bytes
649: */
650: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa,
651: ait_val_t * __restrict pkt, int len);
652: /*
653: * rpc_pkt_Receive() - Receive RPC packet
654: *
655: * @sock = Socket
656: * @type = Type of socket
657: * @sa = Server address
658: * @pkt = RPC packet
659: * @seq = Signed packet with seq.no
660: * return: -1 error, 0 EOF or >0 received bytes
661: */
662: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa,
663: ait_val_t * __restrict pkt, int seq);
664: /*
665: * rpc_pkt_Request() - Build RPC Request packet
666: *
667: * @pkt = Packet buffer
668: * @sess = RPC session info
669: * @tag = Function tag for execution
670: * @vars = Function argument array of values, may be NULL
671: * @noreply = We not want RPC reply
672: * @nocrc = Without CRC calculation
673: * @seq = Sign packet with seq.no
674: * return: -1 error or != -1 prepared bytes into packet
675: */
676: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
677: unsigned short tag, array_t * __restrict vars, int noreply, int nocrc, int seq);
678: /*
679: * rpc_pkt_Replay() - Decode RPC Replay packet
680: *
681: * @pkt = Packet buffer
682: * @sess = RPC session info, if =NULL don't check session
683: * @tag = Function tag, if =CALL_TAG_MAX don't check tag
684: * @vars = Function argument array of values, may be NULL
685: * @nocrc = Without CRC calculation
686: * return: -1 error or != -1 return value from function
687: */
688: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess,
689: unsigned short tag, array_t ** __restrict vars, int nocrc);
690: /*
691: * rpc_cli_execCall() - Execute RPC call
692: *
693: * @cli = RPC Client session
694: * @noreply = We not want RPC reply
695: * @tag = Function tag for execution
696: * @in_vars = IN function argument array of values, may be NULL
697: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
698: * return: -1 error, 0 ok result or 1 closed rpc connection
699: */
700: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,
701: array_t * __restrict in_vars, array_t ** __restrict out_vars);
702: /*
703: * rpc_cli_freeCall() - Free resouce allocated by RPC call
704: *
705: * @out_vars = Returned array with variables from RPC call
706: * return: none
707: */
708: void rpc_cli_freeCall(array_t ** __restrict out_vars);
709: /*
710: * rpc_cli_ping() - Ping RPC server
711: *
712: * @cli = connected client
713: * return: -1 error or !=-1 ping seq id
714: */
715: int rpc_cli_ping(rpc_cli_t *cli);
716:
717:
718: /*
719: * rpc_cli_openBLOBClient() - Connect to BLOB Server
720: *
721: * @rpccli = RPC Client session
722: * @Port = Port for bind server, if Port == 0 default port is selected
723: * return: NULL == error or !=NULL connection to BLOB server established
724: */
725: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
726: /*
727: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
728: *
729: * @cli = BLOB Client session
730: * return: none
731: */
732: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
733:
734:
735: /*
736: * rpc_cli_openClient2() - Connect to layer2 RPC Server
737: *
738: * @InstID = InstID for RPC session request
739: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
740: * @csIface = Interface name for bind client, if NULL first interface on host
741: * @csHost = Host ethernet address
742: * return: NULL == error or !=NULL connection to RPC server established
743: */
744: rpc_cli_t *rpc_cli_openClient2(u_char InstID, int netBuf,
745: const char *csIface, const char *csHost);
746: /*
747: * rpc_cli_closeClient2() - Close layer2 connection to RPC server and free resources
748: *
749: * @cli = RPC Client session
750: * return: none
751: */
752: void rpc_cli_closeClient2(rpc_cli_t ** __restrict cli);
753:
754:
755: /*
756: * rpc_cli_openClientExt() - Connect to pipe RPC Server
757: *
758: * @InstID = InstID for RPC session request
759: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
760: * @fd = File descriptor
761: * return: NULL == error or !=NULL connection to RPC server established
762: */
763: rpc_cli_t *rpc_cli_openClientExt(u_char InstID, int netBuf, int fd);
764: /*
765: * rpc_cli_closeClientExt() - Close pipe connection to RPC server and free resources
766: *
767: * @cli = RPC Client session
768: * return: none
769: */
770: void rpc_cli_closeClientExt(rpc_cli_t ** __restrict cli);
771:
772:
773: #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