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