Annotation of libaitrpc/inc/aitrpc.h, revision 1.2.4.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.2.4.1 ! misho 6: * $Id: aitrpc.h,v 1.2 2011/05/02 23:12:08 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:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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>
53: #include <sys/types.h>
54: #include <sys/param.h>
1.2 misho 55: #if !defined(__NetBSD__)
1.1 misho 56: #include <sys/limits.h>
1.2 misho 57: #endif
1.1 misho 58: #include <sys/socket.h>
59:
60:
61: #define RPC_VERSION 1
62: #define RPC_DEFPORT 2611
63:
64:
65: /* RPC builtin registed calls */
66:
1.2 misho 67: #define CALL_BLOBSHUTDOWN "rpcBLOBServerShutdown"
68: #define CALL_BLOBCLIENTS "rpcBLOBServerClients"
69: #define CALL_BLOBVARS "rpcBLOBServerVars"
70: #define CALL_BLOBSTATE "rpcBLOBServerState"
71:
72: #define CALL_SRVSHUTDOWN "rpcServerShutdown"
1.1 misho 73: #define CALL_SRVCLIENTS "rpcServerClients"
74: #define CALL_SRVCALLS "rpcServerCalls"
75: #define CALL_SRVSESSIONS "rpcServerSessions"
76:
77:
78: /* RPC types */
79:
80: typedef enum {
81: empty, // empty -> variable is not set
1.2 misho 82: buffer, string, blob, // buffer -> uint8_t*; string -> int8_t*; blob -> void*(+socket);
1.1 misho 83: size, offset, datetime, // size -> size_t; offset -> off_t; datetime -> time_t;
84: real, bigreal, // real -> float; bigreal -> double;
85: u8, u16, u32, u64, // unsigned integers ...
86: i8, i16, i32, i64 // integers ...
87: } rpc_type_t;
88:
1.2 misho 89: typedef enum {
90: disable, enable, // for blob.state
91: ok, error, // for blob reply
92: get, set, unset // for blob request
93: } cmd_type_t;
94:
1.1 misho 95: /* RPC value */
96:
97: typedef struct {
98: rpc_type_t val_type;
99: size_t val_len;
100: union {
101: uint8_t *buffer;
102: int8_t *string;
1.2 misho 103: uint32_t blob;
1.1 misho 104: size_t size;
105: off_t offset;
106: time_t datetime;
107: float real;
108: double bigreal;
109: uint8_t u8;
110: uint16_t u16;
111: uint32_t u32;
112: uint64_t u64;
113: int8_t i8;
114: int16_t i16;
115: int32_t i32;
116: int64_t i64;
117: } val;
118: } __packed rpc_val_t;
119:
120: #define RPC_TYPE_VAL(vl) ((vl)->val_type)
121: #define RPC_LEN_VAL(vl) ((vl)->val_len)
1.2 misho 122: #define RPC_BLOB_CHUNKS(vl, n) ((vl)->val_len / (n) + ((vl)->val_len % (n)) ? 1 : 0)
1.1 misho 123: #define RPC_EMPTY_VAL(vl) ((vl)->val_type == empty)
124:
125: #define RPC_GET_BUF(vl) (assert((vl)->val_type == buffer), (vl)->val.buffer)
126: #define RPC_GET_STR(vl) (assert((vl)->val_type == string), (vl)->val.string)
1.2 misho 127: #define RPC_GET_BLOB(vl) (assert((vl)->val_type == blob), (vl)->val.blob)
1.1 misho 128: #define RPC_GET_SIZE(vl) (assert((vl)->val_type == size), (vl)->val.size)
129: #define RPC_GET_OFF(vl) (assert((vl)->val_type == offset), (vl)->val.offset)
130: #define RPC_GET_TIME(vl) (assert((vl)->val_type == datetime), (vl)->val.datetime)
131: #define RPC_GET_REAL(vl) (assert((vl)->val_type == real), (vl)->val.real)
132: #define RPC_GET_BREAL(vl) (assert((vl)->val_type == bigreal), (vl)->val.bigreal)
133: #define RPC_GET_U8(vl) (assert((vl)->val_type == u8), (vl)->val.u8)
134: #define RPC_GET_U16(vl) (assert((vl)->val_type == u16), (vl)->val.u16)
135: #define RPC_GET_U32(vl) (assert((vl)->val_type == u32), (vl)->val.u32)
136: #define RPC_GET_U64(vl) (assert((vl)->val_type == u64), (vl)->val.u64)
137: #define RPC_GET_I8(vl) (assert((vl)->val_type == i8), (vl)->val.i8)
138: #define RPC_GET_I16(vl) (assert((vl)->val_type == i16), (vl)->val.i16)
139: #define RPC_GET_I32(vl) (assert((vl)->val_type == i32), (vl)->val.i32)
140: #define RPC_GET_I64(vl) (assert((vl)->val_type == i64), (vl)->val.i64)
141:
142: #define RPC_SET_BUF(vl, v, l) do { rpc_val_t *val = (vl); assert(val); val->val.buffer = malloc(l); \
143: if (val->val.buffer) { \
144: val->val_type = buffer; val->val_len = l; \
145: memcpy(val->val.buffer, v, l); \
146: } } while (0)
147: #define RPC_SET_STR(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val.string = (int8_t*) strdup(v); \
148: if (val->val.string) { \
149: val->val_type = string; val->val_len = strlen(v) + 1; \
150: } } while (0)
1.2 misho 151: #define RPC_SET_BLOB(vl, v, l) do { rpc_val_t *val = (vl); assert(val); val->val_type = blob; \
152: val->val.blob = v; val->val_len = l; } while (0)
153: #define RPC_SET_BLOB2(vl, b) do { rpc_val_t *val = (vl); assert(val); assert(b); val->val_type = blob; \
154: val->val.blob = b->blob_var; val->val_len = b->blob_len; } while (0)
1.1 misho 155: #define RPC_SET_SIZE(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = size; val->val.size = v; \
156: val->val_len = sizeof(size_t); } while (0)
157: #define RPC_SET_OFF(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = offset; val->val.offset = v; \
158: val->val_len = sizeof(off_t); } while (0)
159: #define RPC_SET_TIME(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = datetime; val->val.datetime = v; \
160: val->val_len = sizeof(time_t); } while (0)
161: #define RPC_SET_REAL(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = real; val->val.real = v; \
162: val->val_len = sizeof(float); } while (0)
163: #define RPC_SET_BREAL(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = bigreal; val->val.bigreal = v; \
164: val->val_len = sizeof(double); } while (0)
165: #define RPC_SET_U8(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u8; val->val.u8 = v; \
166: val->val_len = sizeof(uint8_t); } while (0)
167: #define RPC_SET_U16(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u16; val->val.u16 = v; \
168: val->val_len = sizeof(uint16_t); } while (0)
169: #define RPC_SET_U32(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u32; val->val.u32 = v; \
170: val->val_len = sizeof(uint32_t); } while (0)
171: #define RPC_SET_U64(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = u64; val->val.u64 = v; \
172: val->val_len = sizeof(uint64_t); } while (0)
173: #define RPC_SET_I8(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i8; val->val.i8 = v; \
174: val->val_len = sizeof(int8_t); } while (0)
175: #define RPC_SET_I16(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i16; val->val.i16 = v; \
176: val->val_len = sizeof(int16_t); } while (0)
177: #define RPC_SET_I32(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i32; val->val.i32 = v; \
178: val->val_len = sizeof(int32_t); } while (0)
179: #define RPC_SET_I64(vl, v) do { rpc_val_t *val = (vl); assert(val); val->val_type = i64; val->val.i64 = v; \
180: val->val_len = sizeof(int64_t); } while (0)
181:
182: #define RPC_FREE_VAL(vl) do { rpc_val_t *val = (vl); assert(val); \
183: if (val->val_type == buffer && val->val.buffer) { \
184: free(val->val.buffer); \
185: val->val.buffer = NULL; \
186: } \
187: if (val->val_type == string && val->val.string) { \
188: free(val->val.string); \
189: val->val.string = NULL; \
190: } \
191: val->val_type = val->val_len = 0; \
192: } while (0)
193:
194:
1.2 misho 195: #define RPC_CALLBACK_CHECK_INPUT(x) do { \
196: if (!x) { \
197: rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \
198: return -1; \
199: } \
200: } while (0)
201: #define RPC_CALLBACK_CHK_ARGS(f, n) do { \
202: RPC_CALLBACK_CHECK_INPUT(f); \
203: if (f && f->func_args != n) { \
1.1 misho 204: rpc_SetErr(22, "Error:: different number of arguments!\n"); \
205: return -1; \
206: } \
1.2 misho 207: } while (0)
1.1 misho 208:
209:
210: /* RPC session identification */
211:
212: typedef struct {
213: uint8_t sess_version;
214: uint32_t sess_program;
215: uint32_t sess_process;
216: } __packed rpc_sess_t;
217:
218:
219: /* Server managment RPC functions ... */
220:
221: // RPC function registration element!
222: typedef struct tagRPCFunc {
223: uint16_t func_tag;
224: uint32_t func_hash;
225: int8_t func_file[MAXPATHLEN];
226: int8_t func_name[UCHAR_MAX + 1];
227:
228: int8_t func_args;
229: rpc_val_t *func_vals;
230:
1.2 misho 231: void *func_parent;
1.1 misho 232: struct tagRPCFunc *func_next;
233: } rpc_func_t;
234:
235:
236: /* Network RPC packet - Client request */
237:
238: struct tagRPCCall {
239: rpc_sess_t call_session;
240: uint16_t call_tag;
241: uint32_t call_hash;
242: uint8_t call_argc;
243: } __packed;
244:
245: /* Network RPC packet - Server response */
246:
247: struct tagRPCRet {
248: rpc_sess_t ret_session;
249: uint16_t ret_tag;
250: uint32_t ret_hash;
251: int32_t ret_retcode;
252: int32_t ret_errno;
253: uint8_t ret_argc;
254: } __packed;
255:
1.2 misho 256: /* Network BLOB packet - Header */
257:
258: struct tagBLOBHdr {
259: rpc_sess_t hdr_session;
260: uint8_t hdr_cmd;
261: uint32_t hdr_var;
262: uint32_t hdr_len;
263: uint32_t hdr_ret;
264: } __packed;
265:
1.1 misho 266: /* Network RPC client & server elements */
267:
268: typedef struct {
269: struct sockaddr cli_sa; // host info
270: int cli_sock; // socket
271: pthread_t cli_tid; // TID of thread
272:
273: void *cli_parent; // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
274: } rpc_cli_t;
275:
1.2 misho 276:
277: // BLOB registration element!
278: typedef struct tagBLOB {
279: uint32_t blob_var;
280:
281: size_t blob_len; // size of allocated BLOB data
282: void *blob_data; // BLOB data
283:
284: struct tagBLOB *blob_next;
285: } rpc_blob_t;
286:
1.1 misho 287: typedef struct {
1.2 misho 288: rpc_sess_t srv_session; // RPC session registration info
1.1 misho 289: int srv_numcli; // maximum concurent client connections
290:
1.2 misho 291: rpc_cli_t srv_server; // RPC server socket
292: rpc_cli_t *srv_clients; // connected rpc client sockets
293:
294: rpc_func_t *srv_funcs; // registered functions list
295:
296: pthread_mutex_t srv_mtx;
297:
298: struct {
299: int state; // BLOB server state: ==0 disable | !=0 enable
300: char dir[UCHAR_MAX + 1];
301:
302: rpc_cli_t server; // BLOB server socket
303: rpc_cli_t *clients; // connected blob client sockets
1.1 misho 304:
1.2 misho 305: rpc_blob_t *blobs; // registered blob variables list
1.1 misho 306:
1.2 misho 307: pthread_mutex_t mtx;
308: } srv_blob;
1.1 misho 309: } rpc_srv_t;
310:
311:
1.2 misho 312: /*
313: * (*rpc_callback_t)() Callback type definition for RPC call in server process
314: * @arg1 = current execution RPC call function
315: * @arg2 = number of items in input array from call request
316: * @arg3 = input array with values from RPC call execution request
317: * return: -1 error or >-1 success execution
318: */
319: typedef int (*rpc_callback_t)(rpc_func_t *, int, rpc_val_t *);
1.1 misho 320:
321:
322: // -----------------------------------------------------------------------
323:
324: /* Error support functions */
325:
326: // cli_GetErrno() Get error code of last operation
327: inline int cli_GetErrno();
328: // cli_GetError() Get error text of last operation
329: inline const char *cli_GetError();
330:
331:
332: /* RPC Server side functions */
333:
334: /*
335: * rpc_srv_initServer() Init & create RPC Server
336: * @regProgID = ProgramID for authentication & recognition
337: * @regProcID = ProcessID for authentication & recognition
338: * @concurentClients = Concurent clients at same time to this server
1.2.4.1 ! misho 339: * @sockType = Socket type, like SOCK_STREAM, SOCK_DGRAM or SOCK_RAW
! 340: * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
! 341: * @csHost = Host name or address for bind server, if NULL any address
1.1 misho 342: * @Port = Port for bind server, if Port == 0 default port is selected
343: * return: NULL == error or !=NULL bind and created RPC server instance
344: */
345: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients,
1.2.4.1 ! misho 346: int sockType, u_short family, const char *csHost, u_short Port);
1.1 misho 347: /*
348: * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources
349: * @srv = RPC Server instance
350: * return: none
351: */
352: void rpc_srv_endServer(rpc_srv_t * __restrict srv);
353: /*
354: * rpc_srv_execServer() Execute Main server loop and wait for clients requests
355: * @srv = RPC Server instance
356: * return: -1 error or 0 ok, infinite loop ...
357: */
358: int rpc_srv_execServer(rpc_srv_t * __restrict srv);
359:
360: /*
1.2 misho 361: * rpc_srv_initBLOBServer() Init & create BLOB Server
362: * @Port = Port for bind server, if Port == 0 default port is selected
363: * @diskDir = Disk place for BLOB file objects
364: * return: -1 == error or 0 bind and created BLOB server instance
365: */
366: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
367: /*
368: * rpc_srv_endBLOBServer() Destroy BLOB server, close all opened sockets and free resources
369: * @srv = RPC Server instance
370: * return: none
371: */
372: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
373: /*
374: * rpc_srv_execBLOBServer() Execute Main BLOB server loop and wait for clients requests
375: * @srv = RPC Server instance
376: * return: -1 error or 0 ok, infinite loop ...
377: */
378: int rpc_srv_execBLOBServer(rpc_srv_t * __restrict srv);
379:
380: /*
1.1 misho 381: * rpc_srv_registerCall() Register call to RPC server
382: * @srv = RPC Server instance
383: * @csModule = Module name, if NULL self binary
384: * @csFunc = Function name
1.2 misho 385: * @args = Number of return function arguments, use for restriction case!
1.1 misho 386: * return: -1 error or 0 register ok
387: */
388: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc,
389: unsigned char args);
390: /*
391: * rpc_srv_unregisterCall() Unregister call from RPC server
392: * @srv = RPC Server instance
393: * @csModule = Module name, if NULL self binary
394: * @csFunc = Function name
395: * return: -1 error, 0 not found call, 1 unregister ok
396: */
397: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
398: /*
399: * rpc_srv_getFunc() Get registered call from RPC server by Name
400: * @srv = RPC Server instance
401: * @csModule = Module name, if NULL self binary
402: * @csFunc = Function name
403: * return: NULL not found call, !=NULL return call
404: */
405: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
406: /*
407: * rpc_srv_getCall() Get registered call from RPC server
408: * @srv = RPC Server instance
409: * @tag = tag for function
410: * @hash = hash for function
411: * return: NULL not found call, !=NULL return call
412: */
413: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
414: /*
415: * rpc_srv_execCall() Execute registered call from RPC server
416: * @call = Register RPC call
417: * @rpc = IN RPC call structure
418: * @args = IN RPC call array of rpc values
419: * return: -1 error, !=-1 ok
420: */
1.2 misho 421: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc,
422: rpc_val_t * __restrict args);
1.1 misho 423:
424:
425: /*
1.2 misho 426: * rpc_srv_retValsCall() Declare return variables for RPC call and zeroed values
427: (for safe handling return values, use this!)
428: * @call = RPC function call
429: * @return_vals = Number of return variables
430: * return: NULL error, !=NULL array with return values for RPC call with return_vals items
431: */
432: inline rpc_val_t *rpc_srv_retValsCall(rpc_func_t * __restrict call, int return_vals);
433: /*
434: * rpc_srv_declValsCall() Declare return variables for RPC call,
435: if already allocated memory for RPC call return values
436: function reallocate used space with return_vals count elements
1.1 misho 437: * @call = RPC function call
438: * @return_vals = Number of return variables
439: * return: -1 error, !=-1 ok
440: */
441: inline int rpc_srv_declValsCall(rpc_func_t * __restrict call, int return_vals);
442: /*
443: * rpc_srv_freeValsCall() Free return variables for RPC call
444: * @call = RPC function call
445: * return: none
446: */
447: inline void rpc_srv_freeValsCall(rpc_func_t * __restrict call);
448: /*
449: * rpc_srv_copyValsCall() Copy return variables for RPC call to new variable
450: * @call = RPC function call
451: * @newvals = New allocated variables array, must be free after use
452: * return: -1 error, !=-1 Returned number of copied RPC variables
453: */
454: inline int rpc_srv_copyValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict newvals);
455: /*
1.2 misho 456: * rpc_srv_zeroValsCall() Clean values from return variables of RPC call
1.1 misho 457: * @call = RPC function call
458: * return: -1 error, !=-1 Returned number of cleaned RPC variables
459: */
1.2 misho 460: inline int rpc_srv_zeroValsCall(rpc_func_t * __restrict call);
1.1 misho 461: /*
462: * rpc_srv_getValsCall() Get return variables for RPC call
463: * @call = RPC function call
464: * @vals = Returned variables, may be NULL
465: * return: -1 error, !=-1 Number of returned variables
466: */
467: inline int rpc_srv_getValsCall(rpc_func_t * __restrict call, rpc_val_t ** __restrict vals);
468:
469:
1.2 misho 470: /*
471: * rpc_srv_blobCreate() Create map blob to memory region and return object
472: * @srv = RPC Server instance
473: * @len = BLOB length object
474: * return: NULL error or !=NULL allocated BLOB object
475: */
476: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
477: /*
478: * rpc_srv_blobMap() Map blob to memory region
479: * @srv = RPC Server instance
480: * @blob = Map to this BLOB element
481: * return: -1 error or 0 ok
482: */
483: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
484: /*
485: * rpc_srv_blobUnmap() Unmap blob memory region
486: * @blob = Mapped BLOB element
487: * return: none
488: */
489: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
490: /*
491: * rpc_srv_blobFree() Free blob from disk & memory
492: * @srv = RPC Server instance
493: * @blob = Mapped BLOB element
494: * return: -1 error or 0 ok
495: */
496: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
497:
498: /*
499: * rpc_srv_registerBLOB() Register new BLOB to server
500: * @srv = RPC Server instance
501: * @len = BLOB length
502: * return: NULL error or new registered BLOB
503: */
504: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
505: /*
506: * rpc_srv_unregisterBLOB() Unregister BLOB from server
507: * @srv = RPC Server instance
508: * @var = BLOB Variable for unregister
509: * return: -1 error, 0 not found call, 1 unregister ok
510: */
511: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
512: /*
513: * rpc_srv_getBLOB() Get registered BLOB
514: * @srv = RPC Server instance
515: * @var = hash for variable
516: * return: NULL not found, !=NULL return blob var
517: */
518: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
519:
520: /*
521: * rpc_srv_sendBLOB() Send mapped BLOB to client
522: * @cli = Client instance
523: * @blob = Mapped BLOB element
524: * return: -1 error, 0 ok
525: */
526: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
527: /*
528: * rpc_srv_recvBLOB() Receive BLOB from client
529: * @cli = Client instance
530: * @blob = Mapped BLOB element
531: * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
532: */
533: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
534:
535: /*
536: * rpc_cli_sendBLOB() Send BLOB to server
537: * @cli = Client instance
538: * @var = BLOB variable
539: * @data = BLOB data
540: * return: -1 error, 0 ok, 1 remote error
541: */
542: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void * __restrict data);
543: /*
544: * rpc_cli_recvBLOB() Receive BLOB from server
545: * @cli = Client instance
546: * @var = BLOB variable
547: * @data = BLOB data, must be free after use!
548: * return: -1 error, 0 ok, 1 remote error
549: */
550: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void ** data);
551: /*
552: * rpc_cli_delBLOB() Delete BLOB from server
553: * @cli = Client instance
554: * @var = BLOB variable
555: * return: -1 error, 0 ok, 1 remote error
556: */
557: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var);
558: /*
559: * rpc_cli_getBLOB() Receive BLOB from server and Delete after that.
560: * @cli = Client instance
561: * @var = BLOB variable
562: * @data = BLOB data, must be free after use!
563: * return: -1 error, 0 ok, >0 remote error
564: */
565: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, rpc_val_t * __restrict var, void ** data);
566:
567:
568:
1.1 misho 569: /* RPC Client side functions */
570:
571: /*
572: * rpc_cli_openClient() Connect to RPC Server
573: * @ProgID = ProgramID for RPC session request
574: * @ProcID = ProcessID for RPC session request
575: * @family = Family socket type, AF_INET or AF_INET6
576: * @csHost = Host name or IP address for bind server
577: * @Port = Port for bind server, if Port == 0 default port is selected
578: * return: NULL == error or !=NULL connection to RPC server established
579: */
580: rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, u_short family,
581: const char *csHost, u_short Port);
582: /*
583: * rpc_cli_closeClient() Close connection to RPC server and free resources
584: * @cli = RPC Client session
585: * return: none
586: */
587: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
588: /*
589: * rpc_cli_execCall() Execute RPC call
590: * @cli = RPC Client session
591: * @csModule = Module name, if NULL self binary
592: * @csFunc = Function name for execute
593: * @in_argc = IN count of arguments
594: * @in_vals = IN RPC call array of rpc values
595: * @out_argc = OUT returned count of arguments
596: * @out_vals = OUT returned array of rpc values, must be free after use (see rpc_cli_freeVals())
597: * return: -1 error or != -1 ok result
598: */
599: int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, int in_argc,
600: rpc_val_t * __restrict in_vals, int *out_argc, rpc_val_t ** __restrict out_vals);
601: /*
602: * rpc_cli_freeVals() Free rpc_val_t array returned from RPC call
603: * @args = Number of arguments in array
604: * @vals = Value elements
605: * return: none
606: */
607: inline void rpc_cli_freeVals(int args, rpc_val_t *vals);
608:
609:
1.2 misho 610: /*
611: * rpc_cli_openBLOBClient() Connect to BLOB Server
612: * @rpccli = RPC Client session
613: * @Port = Port for bind server, if Port == 0 default port is selected
614: * return: NULL == error or !=NULL connection to BLOB server established
615: */
616: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
617: /*
618: * rpc_cli_closeBLOBClient() Close connection to BLOB server and free resources
619: * @cli = BLOB Client session
620: * return: none
621: */
622: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
623:
624:
1.1 misho 625: #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