Annotation of libaitrpc/inc/aitrpc.h, revision 1.8.2.24
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.8.2.24! misho 6: * $Id: aitrpc.h,v 1.8.2.23 2012/05/17 16:43:21 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.6 misho 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
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.8.2.1 misho 60: #include <sys/queue.h>
1.4 misho 61: #include <aitio.h>
1.6 misho 62: #include <aitsched.h>
1.1 misho 63:
64:
1.8.2.1 misho 65: #define RPC_VERSION 4
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.8.2.14 misho 75: #define CALL_TAG_MAX 65535
1.8.2.5 misho 76:
1.8.2.17 misho 77: #define CALL_SRVPING 65534
1.8.2.16 misho 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.8.2.24! 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.8.2.2 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.8.2.2 misho 123: uint16_t call_seq;
1.7 misho 124: uint16_t call_len;
1.8.2.2 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.8.2.2 misho 137: uint16_t call_tag;
138: uint16_t call_argc;
139: ait_val_t call_argv[0];
1.8.2.4 misho 140: } __packed; /* size == 24 bytes */
1.8.2.24! misho 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.8.2.13 misho 153: } __packed; /* size == 22 bytes */
1.2 misho 154:
1.1 misho 155: /* Network RPC client & server elements */
156:
1.8.2.2 misho 157: /* RPC function registration element! */
158: typedef struct tagRPCFunc {
159: ait_val_t func_name;
160:
161: void *func_parent;
162: TAILQ_ENTRY(tagRPCFunc) func_node;
163: } rpc_func_t;
1.8.2.16 misho 164: #define RPC_FUNC_SERVER(x) ((rpc_srv_t*) (x)->func_parent)
1.8.2.2 misho 165:
166:
1.8.2.8 misho 167: /* BLOB register element */
168: typedef struct tagBLOB {
169: uint32_t blob_var; /* BLOB id */
170:
171: size_t blob_len; /* size of allocated BLOB data */
172: void *blob_data; /* mapped BLOB data */
173:
174: TAILQ_ENTRY(tagBLOB) blob_node;
175: } rpc_blob_t;
176:
177:
1.1 misho 178: typedef struct {
1.8.2.1 misho 179: int cli_id; /* slot id */
180: int cli_sock; /* socket fd */
181: io_sockaddr_t cli_sa; /* host address */
182: ait_val_t cli_buf; /* network buffer */
1.8 misho 183:
1.8.2.24! misho 184: array_t *cli_vars; /* function return variables */
! 185:
1.8.2.1 misho 186: void *cli_parent; /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
1.1 misho 187: } rpc_cli_t;
1.8.2.24! misho 188: #define RPC_RETVARS(x) ((x)->cli_vars)
! 189: #define RPC_SRV_SERVER(x) ((rpc_srv_t*) (x)->cli_parent)
! 190: #define RPC_CLI_SESSION(x) ((rpc_sess_t*) (x)->cli_parent)
1.1 misho 191:
192: typedef struct {
1.8.2.1 misho 193: rpc_sess_t srv_session; /* RPC session registration info */
194: int srv_netbuf; /* size of network buffer */
1.1 misho 195:
1.8.2.18 misho 196: pthread_t srv_tid; /* RPC exec pthread */
1.8.2.1 misho 197: sched_root_task_t *srv_root; /* RPC server scheduler */
198: intptr_t srv_kill; /* Scheduler condition variable */
1.2 misho 199:
1.8.2.1 misho 200: rpc_cli_t srv_server; /* RPC server socket */
201: array_t *srv_clients; /* connected rpc client sockets */
1.2 misho 202:
1.8.2.1 misho 203: TAILQ_HEAD(, tagRPCFunc) srv_funcs; /* RPC functions list */
1.2 misho 204:
205: struct {
1.8.2.18 misho 206: pthread_t tid; /* BLOB exec pthread */
1.8.2.10 misho 207: sched_root_task_t *root; /* BLOB server scheduler */
208: intptr_t kill; /* BLOB server state: ==0 disable | !=0 enable */
209:
1.8.2.8 misho 210: ait_val_t dir; /* BLOB states directory */
1.2 misho 211:
1.8.2.8 misho 212: rpc_cli_t server; /* BLOB server socket */
213: array_t *clients; /* connected blob client sockets */
1.1 misho 214:
1.8.2.8 misho 215: TAILQ_HEAD(, tagBLOB) blobs; /* registered blob variables list */
1.8.2.1 misho 216: } srv_blob;
1.1 misho 217: } rpc_srv_t;
218:
219:
1.2 misho 220: /*
1.6 misho 221: * (*rpc_callback_t)() - Callback type definition for RPC call in server process
222: *
1.8.2.24! misho 223: * @arg1 = RPC client
1.8.2.17 misho 224: * @arg2 = RPC packet header
1.2 misho 225: * @arg3 = input array with values from RPC call execution request
226: * return: -1 error or >-1 success execution
227: */
1.8.2.24! misho 228: typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *);
1.1 misho 229:
230:
1.8.2.19 misho 231: /* ----------------------------------------------------------------------- */
1.1 misho 232:
233: /* Error support functions */
234:
1.3 misho 235: // rpc_GetErrno() Get error code of last operation
236: inline int rpc_GetErrno();
237: // rpc_GetError() Get error text of last operation
238: inline const char *rpc_GetError();
1.1 misho 239:
240:
1.5 misho 241: /*
1.8.2.1 misho 242: * rpc_chkPktSession() - Check RPC session
1.6 misho 243: *
1.5 misho 244: * @p = packet session
245: * @s = active session
1.8.2.1 misho 246: * return: -1, 1, 2, 3 are errors or 0 ok
1.5 misho 247: */
248: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
249: /*
1.8.2.1 misho 250: * rpc_addPktSession() - Prepare session into network format
1.6 misho 251: *
1.5 misho 252: * @p = packet session
1.8.2.1 misho 253: * @s = host session
1.5 misho 254: * return: -1 error or 0 ok
255: */
256: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
1.8.2.1 misho 257: /*
1.8.2.17 misho 258: * rpc_register_srvPing() - Register ping service function
259: *
260: * @srv = RPC server instance
261: * return: -1 error or 0 ok
262: */
263: inline int rpc_register_srvPing(rpc_srv_t * __restrict srv);
264: /*
1.8.2.1 misho 265: * rpc_register_srvServices() - Register internal service functions
266: *
267: * @srv = RPC server instance
268: * return: -1 error or 0 ok
269: */
270: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
1.8.2.6 misho 271: /*
272: * rpc_register_blobServices() - Register internal service functions
273: *
274: * @srv = RPC server instance
275: * return: -1 error or 0 ok
276: */
277: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
1.5 misho 278:
279:
1.1 misho 280: /* RPC Server side functions */
281:
282: /*
1.6 misho 283: * rpc_srv_initServer() - Init & create RPC Server
284: *
1.1 misho 285: * @regProgID = ProgramID for authentication & recognition
286: * @regProcID = ProcessID for authentication & recognition
287: * @concurentClients = Concurent clients at same time to this server
1.8.2.20 misho 288: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.3 misho 289: * @csHost = Host name or address for bind server, if NULL any address
1.1 misho 290: * @Port = Port for bind server, if Port == 0 default port is selected
291: * return: NULL == error or !=NULL bind and created RPC server instance
292: */
1.8.2.2 misho 293: rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID,
294: int concurentClients, int netBuf,
295: const char *csHost, unsigned short Port);
1.1 misho 296: /*
1.6 misho 297: * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
298: *
1.5 misho 299: * @psrv = RPC Server instance
1.1 misho 300: * return: none
301: */
1.8.2.23 misho 302: inline void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1 misho 303: /*
1.6 misho 304: * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
305: *
1.1 misho 306: * @srv = RPC Server instance
307: * return: -1 error or 0 ok, infinite loop ...
308: */
1.4 misho 309: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
1.8.2.18 misho 310: #define rpc_srv_execServer(_srv, _sync) do { assert((_srv)); \
1.8.2.10 misho 311: if (!(_srv)->srv_kill) { \
1.8.2.18 misho 312: pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
1.8.2.10 misho 313: rpc_srv_loopServer, (_srv)); \
314: if ((_sync)) \
1.8.2.18 misho 315: pthread_join((_srv)->srv_tid, (void**) (_sync)); \
1.8.2.10 misho 316: else \
1.8.2.18 misho 317: pthread_detach((_srv)->srv_tid); \
1.8.2.10 misho 318: } } while (0)
1.1 misho 319:
320: /*
1.6 misho 321: * rpc_srv_initBLOBServer() - Init & create BLOB Server
322: *
1.3 misho 323: * @srv = RPC server instance
1.2 misho 324: * @Port = Port for bind server, if Port == 0 default port is selected
325: * @diskDir = Disk place for BLOB file objects
326: * return: -1 == error or 0 bind and created BLOB server instance
327: */
1.8.2.19 misho 328: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
1.2 misho 329: /*
1.6 misho 330: * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
331: *
1.2 misho 332: * @srv = RPC Server instance
333: * return: none
334: */
1.8.2.22 misho 335: inline void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
1.2 misho 336: /*
1.6 misho 337: * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
338: *
1.2 misho 339: * @srv = RPC Server instance
340: * return: -1 error or 0 ok, infinite loop ...
341: */
1.8.2.10 misho 342: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
1.8.2.18 misho 343: #define rpc_srv_execBLOBServer(_srv) do { assert((_srv)); \
1.8.2.10 misho 344: if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
1.8.2.18 misho 345: pthread_create(&(_srv)->srv_blob.tid, NULL, \
346: (void*(*)(void*)) \
1.8.2.10 misho 347: rpc_srv_loopBLOBServer, (_srv)); \
1.8.2.18 misho 348: pthread_detach((_srv)->srv_blob.tid); \
1.4 misho 349: } \
350: } while (0)
1.2 misho 351:
352: /*
1.6 misho 353: * rpc_srv_registerCall() - Register call to RPC server
354: *
1.1 misho 355: * @srv = RPC Server instance
1.8.2.4 misho 356: * @tag = Function tag
357: * @funcaddr = Function address
358: * return: -1 error, 0 already registered tag or 1 register ok
1.1 misho 359: */
1.8.2.24! misho 360: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
1.1 misho 361: /*
1.6 misho 362: * rpc_srv_unregisterCall() - Unregister call from RPC server
363: *
1.1 misho 364: * @srv = RPC Server instance
1.8.2.4 misho 365: * @tag = Function tag
1.1 misho 366: * return: -1 error, 0 not found call, 1 unregister ok
367: */
1.8.2.4 misho 368: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
1.1 misho 369: /*
1.8.2.4 misho 370: * rpc_srv_getCall() - Get registered call from RPC server
1.6 misho 371: *
1.1 misho 372: * @srv = RPC Server instance
373: * @tag = tag for function
374: * return: NULL not found call, !=NULL return call
375: */
1.8.2.2 misho 376: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
1.1 misho 377: /*
1.8.2.24! misho 378: * rpc_srv_execCall() Execute registered call from RPC server
1.6 misho 379: *
1.8.2.24! misho 380: * @cli = RPC client
1.1 misho 381: * @rpc = IN RPC call structure
1.8.2.24! misho 382: * @funcname = Execute RPC function
1.4 misho 383: * @args = IN RPC calling arguments from RPC client
1.1 misho 384: * return: -1 error, !=-1 ok
385: */
1.8.2.24! misho 386: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc,
! 387: ait_val_t funcname, array_t * __restrict args);
1.1 misho 388:
389:
390: /*
1.8.2.9 misho 391: * rpc_srv_blobCreate() - Create and map blob to memory region and return object
1.6 misho 392: *
1.2 misho 393: * @srv = RPC Server instance
394: * @len = BLOB length object
395: * return: NULL error or !=NULL allocated BLOB object
396: */
397: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
398: /*
1.6 misho 399: * rpc_srv_blobMap() - Map blob to memory region
400: *
1.2 misho 401: * @srv = RPC Server instance
402: * @blob = Map to this BLOB element
403: * return: -1 error or 0 ok
404: */
405: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
406: /*
1.6 misho 407: * rpc_srv_blobUnmap() - Unmap blob memory region
408: *
1.2 misho 409: * @blob = Mapped BLOB element
410: * return: none
411: */
412: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
413: /*
1.6 misho 414: * rpc_srv_blobFree() - Free blob from disk & memory
415: *
1.2 misho 416: * @srv = RPC Server instance
417: * @blob = Mapped BLOB element
418: * return: -1 error or 0 ok
419: */
420: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
421:
422: /*
1.6 misho 423: * rpc_srv_registerBLOB() - Register new BLOB to server
424: *
1.2 misho 425: * @srv = RPC Server instance
426: * @len = BLOB length
427: * return: NULL error or new registered BLOB
428: */
429: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
430: /*
1.6 misho 431: * rpc_srv_unregisterBLOB() - Unregister BLOB from server
432: *
1.2 misho 433: * @srv = RPC Server instance
434: * @var = BLOB Variable for unregister
435: * return: -1 error, 0 not found call, 1 unregister ok
436: */
437: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
438: /*
1.6 misho 439: * rpc_srv_getBLOB() - Get registered BLOB
440: *
1.2 misho 441: * @srv = RPC Server instance
442: * @var = hash for variable
443: * return: NULL not found, !=NULL return blob var
444: */
445: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
446:
447: /*
1.6 misho 448: * rpc_srv_sendBLOB() - Send mapped BLOB to client
449: *
1.2 misho 450: * @cli = Client instance
451: * @blob = Mapped BLOB element
452: * return: -1 error, 0 ok
453: */
454: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
455: /*
1.6 misho 456: * rpc_srv_recvBLOB() - Receive BLOB from client
457: *
1.2 misho 458: * @cli = Client instance
459: * @blob = Mapped BLOB element
460: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
461: */
462: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
463:
1.4 misho 464: /* CLIENT part of functions */
465:
1.2 misho 466: /*
1.6 misho 467: * rpc_cli_sendBLOB() - Send BLOB to server
468: *
1.2 misho 469: * @cli = Client instance
470: * @var = BLOB variable
471: * @data = BLOB data
472: * return: -1 error, 0 ok, 1 remote error
473: */
1.4 misho 474: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
1.2 misho 475: /*
1.6 misho 476: * rpc_cli_recvBLOB() - Receive BLOB from server
477: *
1.2 misho 478: * @cli = Client instance
479: * @var = BLOB variable
480: * @data = BLOB data, must be free after use!
481: * return: -1 error, 0 ok, 1 remote error
482: */
1.4 misho 483: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2 misho 484: /*
1.6 misho 485: * rpc_cli_delBLOB() - Delete BLOB from server
486: *
1.2 misho 487: * @cli = Client instance
488: * @var = BLOB variable
489: * return: -1 error, 0 ok, 1 remote error
490: */
1.4 misho 491: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2 misho 492: /*
1.6 misho 493: * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
494: *
1.2 misho 495: * @cli = Client instance
496: * @var = BLOB variable
497: * @data = BLOB data, must be free after use!
498: * return: -1 error, 0 ok, >0 remote error
499: */
1.6 misho 500: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,
501: void ** __restrict data);
1.2 misho 502:
503:
1.1 misho 504: /* RPC Client side functions */
505:
506: /*
1.6 misho 507: * rpc_cli_openClient() - Connect to RPC Server
508: *
1.1 misho 509: * @ProgID = ProgramID for RPC session request
510: * @ProcID = ProcessID for RPC session request
1.8.2.21 misho 511: * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.1 misho 512: * @csHost = Host name or IP address for bind server
513: * @Port = Port for bind server, if Port == 0 default port is selected
514: * return: NULL == error or !=NULL connection to RPC server established
515: */
1.8.2.11 misho 516: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf,
1.8.2.15 misho 517: const char *csHost, unsigned short Port);
1.1 misho 518: /*
1.6 misho 519: * rpc_cli_closeClient() - Close connection to RPC server and free resources
520: *
1.1 misho 521: * @cli = RPC Client session
522: * return: none
523: */
1.8.2.11 misho 524: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
1.1 misho 525: /*
1.6 misho 526: * rpc_cli_execCall() - Execute RPC call
527: *
1.1 misho 528: * @cli = RPC Client session
1.7 misho 529: * @noreply = We not want RPC reply
1.8.2.11 misho 530: * @tag = Function tag for execution
1.8.2.19 misho 531: * @in_vars = IN RPC call array of rpc values, may be NULL
532: * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars()
1.1 misho 533: * return: -1 error or != -1 ok result
534: */
1.8.2.19 misho 535: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,
1.4 misho 536: array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.8.2.19 misho 537: /*
538: * rpc_cli_ping() - Ping RPC server
539: *
540: * @cli = connected client
541: * return: -1 error or !=-1 ping seq id
542: */
543: inline int rpc_cli_ping(rpc_cli_t *cli);
1.1 misho 544:
545:
1.2 misho 546: /*
1.6 misho 547: * rpc_cli_openBLOBClient() - Connect to BLOB Server
548: *
1.2 misho 549: * @rpccli = RPC Client session
550: * @Port = Port for bind server, if Port == 0 default port is selected
551: * return: NULL == error or !=NULL connection to BLOB server established
552: */
1.8.2.19 misho 553: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
1.2 misho 554: /*
1.6 misho 555: * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
556: *
1.2 misho 557: * @cli = BLOB Client session
558: * return: none
559: */
1.8.2.11 misho 560: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
1.2 misho 561:
562:
1.1 misho 563: #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