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