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