Annotation of libaitrpc/inc/aitrpc.h, revision 1.4.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.4.2.1 ! misho       6: * $Id: aitrpc.h,v 1.4 2011/09/07 07:24: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: 
                     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>
1.4       misho      59: #include <aitio.h>
1.1       misho      60: 
                     61: 
1.4.2.1 ! misho      62: #define RPC_VERSION            2
1.1       misho      63: #define RPC_DEFPORT            2611
                     64: 
                     65: 
                     66: /* RPC builtin registed calls */
                     67: 
1.2       misho      68: #define CALL_BLOBSHUTDOWN      "rpcBLOBServerShutdown"
                     69: #define CALL_BLOBCLIENTS       "rpcBLOBServerClients"
                     70: #define CALL_BLOBVARS          "rpcBLOBServerVars"
                     71: #define CALL_BLOBSTATE         "rpcBLOBServerState"
                     72: 
                     73: #define CALL_SRVSHUTDOWN       "rpcServerShutdown"
1.1       misho      74: #define CALL_SRVCLIENTS                "rpcServerClients"
                     75: #define CALL_SRVCALLS          "rpcServerCalls"
                     76: #define CALL_SRVSESSIONS       "rpcServerSessions"
                     77: 
                     78: 
                     79: /* RPC types */
                     80: 
                     81: typedef enum {
1.4       misho      82:        disable, enable, running, kill,         /* for blob.state */
                     83:        ok, error,                              /* for blob reply */
                     84:        get, set, unset                         /* for blob request */
1.2       misho      85: } cmd_type_t;
                     86: 
1.1       misho      87: 
1.4       misho      88: #define RPC_CALLBACK_CHECK_INPUT(_f)   do { \
                     89:                                                assert((_f)); \
                     90:                                                if (!(_f)) { \
1.2       misho      91:                                                        rpc_SetErr(22, "Error:: invalid callback parameters ...\n"); \
                     92:                                                        return -1; \
                     93:                                                } \
                     94:                                        } while (0)
1.4       misho      95: #define RPC_CALLBACK_CHK_ARGS(_f, _n)  do { \
                     96:                                                RPC_CALLBACK_CHECK_INPUT((_f)); \
                     97:                                                if ((_f) && io_arraySize((_f)->func_vars) != _n) { \
1.1       misho      98:                                                        rpc_SetErr(22, "Error:: different number of arguments!\n"); \
                     99:                                                        return -1; \
                    100:                                                } \
1.2       misho     101:                                        } while (0)
1.1       misho     102: 
                    103: 
                    104: /* RPC session identification */
                    105: 
                    106: typedef struct {
                    107:        uint8_t         sess_version;
                    108:        uint32_t        sess_program;
                    109:        uint32_t        sess_process;
                    110: } __packed rpc_sess_t;
                    111: 
                    112: 
                    113: /* Server managment RPC functions ... */
                    114: 
                    115: // RPC function registration element!
                    116: typedef struct tagRPCFunc {
                    117:        uint16_t                func_tag;
                    118:        uint32_t                func_hash;
1.4.2.1 ! misho     119:        char                    func_file[MAXPATHLEN];
        !           120:        char                    func_name[UCHAR_MAX + 1];
1.1       misho     121: 
1.4       misho     122:        array_t                 *func_vars;
1.1       misho     123: 
1.2       misho     124:        void                    *func_parent;
1.1       misho     125:        struct tagRPCFunc       *func_next;
                    126: } rpc_func_t;
                    127: 
                    128: 
                    129: /* Network RPC packet - Client request */
                    130: 
                    131: struct tagRPCCall {
                    132:        rpc_sess_t      call_session;
                    133:        uint16_t        call_tag;
                    134:        uint32_t        call_hash;
1.4       misho     135:        uint16_t        call_argc;
1.1       misho     136: } __packed;
                    137: 
                    138: /* Network RPC packet - Server response */
                    139: 
                    140: struct tagRPCRet {
                    141:        rpc_sess_t      ret_session;
                    142:        uint16_t        ret_tag;
                    143:        uint32_t        ret_hash;
                    144:        int32_t         ret_retcode;
                    145:        int32_t         ret_errno;
1.4       misho     146:        uint16_t        ret_argc;
1.1       misho     147: } __packed;
                    148: 
1.2       misho     149: /* Network BLOB packet - Header */
                    150: 
                    151: struct tagBLOBHdr {
                    152:        rpc_sess_t      hdr_session;
                    153:        uint8_t         hdr_cmd;
                    154:        uint32_t        hdr_var;
                    155:        uint32_t        hdr_len;
                    156:        uint32_t        hdr_ret;
                    157: } __packed;
                    158: 
1.1       misho     159: /* Network RPC client & server elements */
                    160: 
                    161: typedef struct {
                    162:        struct sockaddr cli_sa;         // host info
1.3       misho     163:        int             cli_sock;       // socket fd
1.1       misho     164:        pthread_t       cli_tid;        // TID of thread
                    165: 
                    166:        void            *cli_parent;    // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
1.4       misho     167:        int             cli_netbuf;     // size of network buffer size
1.1       misho     168: } rpc_cli_t;
                    169: 
1.2       misho     170: 
                    171: // BLOB registration element!
                    172: typedef struct tagBLOB {
                    173:        uint32_t        blob_var;
                    174: 
                    175:        size_t          blob_len;       // size of allocated BLOB data
                    176:        void            *blob_data;     // BLOB data
                    177: 
                    178:        struct tagBLOB  *blob_next;
                    179: } rpc_blob_t;
                    180: 
1.1       misho     181: typedef struct {
1.2       misho     182:        rpc_sess_t      srv_session;    // RPC session registration info
1.1       misho     183:        int             srv_numcli;     // maximum concurent client connections
1.4       misho     184:        int             srv_netbuf;     // size of network buffer size
1.1       misho     185: 
1.2       misho     186:        rpc_cli_t       srv_server;     // RPC server socket
                    187:        rpc_cli_t       *srv_clients;   // connected rpc client sockets
                    188: 
                    189:        rpc_func_t      *srv_funcs;     // registered functions list
                    190: 
                    191:        pthread_mutex_t srv_mtx;
1.3       misho     192:        cmd_type_t      srv_kill;
1.2       misho     193: 
                    194:        struct {
1.3       misho     195:                cmd_type_t      state;          // BLOB server state: ==0 disable | !=0 enable
1.2       misho     196:                char            dir[UCHAR_MAX + 1];
                    197: 
                    198:                rpc_cli_t       server;         // BLOB server socket
                    199:                rpc_cli_t       *clients;       // connected blob client sockets
1.1       misho     200: 
1.2       misho     201:                rpc_blob_t      *blobs;         // registered blob variables list
1.1       misho     202: 
1.2       misho     203:                pthread_mutex_t mtx;
                    204:        }               srv_blob;
1.1       misho     205: } rpc_srv_t;
                    206: 
                    207: 
1.2       misho     208: /* 
                    209:  * (*rpc_callback_t)() Callback type definition for RPC call in server process
                    210:  * @arg1 = current execution RPC call function
                    211:  * @arg2 = number of items in input array from call request
                    212:  * @arg3 = input array with values from RPC call execution request
                    213:  * return: -1 error or >-1 success execution
                    214:  */
1.4       misho     215: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
1.1       misho     216: 
                    217: 
                    218: // -----------------------------------------------------------------------
                    219: 
                    220: /* Error support functions */
                    221: 
1.3       misho     222: // rpc_GetErrno() Get error code of last operation
                    223: inline int rpc_GetErrno();
                    224: // rpc_GetError() Get error text of last operation
                    225: inline const char *rpc_GetError();
1.1       misho     226: 
                    227: 
1.4.2.1 ! misho     228: /*
        !           229:  * rpc_chkPktSession() Check session in RPC packet
        !           230:  * @p = packet session
        !           231:  * @s = active session
        !           232:  * return: -1 error or 0 ok
        !           233:  */
        !           234: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
        !           235: /*
        !           236:  * rpc_addPktSession() Add session into RPC packet
        !           237:  * @p = packet session
        !           238:  * @s = active session
        !           239:  * return: -1 error or 0 ok
        !           240:  */
        !           241: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
        !           242: 
        !           243: 
1.1       misho     244: /* RPC Server side functions */
                    245: 
                    246: /*
                    247:  * rpc_srv_initServer() Init & create RPC Server
                    248:  * @regProgID = ProgramID for authentication & recognition
                    249:  * @regProcID = ProcessID for authentication & recognition
                    250:  * @concurentClients = Concurent clients at same time to this server
1.4       misho     251:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     252:  * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
                    253:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     254:  * @Port = Port for bind server, if Port == 0 default port is selected
                    255:  * return: NULL == error or !=NULL bind and created RPC server instance
                    256:  */
                    257: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients, 
1.4       misho     258:                int netBuf, u_short family, const char *csHost, u_short Port);
1.1       misho     259: /*
                    260:  * rpc_srv_endServer() Destroy RPC server, close all opened sockets and free resources
                    261:  * @srv = RPC Server instance
                    262:  * return: none
                    263:  */
                    264: void rpc_srv_endServer(rpc_srv_t * __restrict srv);
                    265: /*
1.4       misho     266:  * rpc_srv_loopServer() Execute Main server loop and wait for clients requests
1.1       misho     267:  * @srv = RPC Server instance
                    268:  * return: -1 error or 0 ok, infinite loop ...
                    269:  */
1.4       misho     270: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
                    271: #define rpc_srv_execServer(_srv, _sync)        do { assert((_srv)); pthread_t __tid; \
                    272:                                                pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    273:                                                                rpc_srv_loopServer, (_srv)); \
                    274:                                                if ((_sync)) \
                    275:                                                        pthread_join(__tid, (void**) (_sync)); \
                    276:                                                else \
                    277:                                                        pthread_detach(__tid); \
                    278:                                        } while (0)
1.1       misho     279: 
                    280: /*
1.2       misho     281:  * rpc_srv_initBLOBServer() Init & create BLOB Server
1.3       misho     282:  * @srv = RPC server instance
1.2       misho     283:  * @Port = Port for bind server, if Port == 0 default port is selected
                    284:  * @diskDir = Disk place for BLOB file objects
                    285:  * return: -1 == error or 0 bind and created BLOB server instance
                    286:  */
                    287: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
                    288: /*
                    289:  * rpc_srv_endBLOBServer() Destroy BLOB server, close all opened sockets and free resources
                    290:  * @srv = RPC Server instance
                    291:  * return: none
                    292:  */
                    293: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
                    294: /*
1.4       misho     295:  * rpc_srv_loopBLOB() Execute Main BLOB server loop and wait for clients requests
1.2       misho     296:  * @srv = RPC Server instance
                    297:  * return: -1 error or 0 ok, infinite loop ...
                    298:  */
1.4       misho     299: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
                    300: #define rpc_srv_execBLOBServer(_srv)   do { assert((_srv)); pthread_t __tid; \
                    301:                                                if ((_srv)->srv_blob.state == enable) { \
                    302:                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    303:                                                                        rpc_srv_loopBLOB, (_srv)); \
                    304:                                                        pthread_detach(__tid); \
                    305:                                                        (_srv)->srv_blob.state = running; \
                    306:                                                } \
                    307:                                        } while (0)
1.2       misho     308: 
                    309: /*
1.1       misho     310:  * rpc_srv_registerCall() Register call to RPC server
                    311:  * @srv = RPC Server instance
                    312:  * @csModule = Module name, if NULL self binary
                    313:  * @csFunc = Function name
1.2       misho     314:  * @args = Number of return function arguments, use for restriction case!
1.1       misho     315:  * return: -1 error or 0 register ok
                    316:  */
                    317: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, 
1.4       misho     318:                unsigned short args);
1.1       misho     319: /*
                    320:  * rpc_srv_unregisterCall() Unregister call from RPC server
                    321:  * @srv = RPC Server instance
                    322:  * @csModule = Module name, if NULL self binary
                    323:  * @csFunc = Function name
                    324:  * return: -1 error, 0 not found call, 1 unregister ok
                    325:  */
                    326: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    327: /*
                    328:  * rpc_srv_getFunc() Get registered call from RPC server by Name
                    329:  * @srv = RPC Server instance
                    330:  * @csModule = Module name, if NULL self binary
                    331:  * @csFunc = Function name
                    332:  * return: NULL not found call, !=NULL return call
                    333:  */
                    334: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    335: /*
                    336:  * rpc_srv_getCall() Get registered call from RPC server
                    337:  * @srv = RPC Server instance
                    338:  * @tag = tag for function
                    339:  * @hash = hash for function
                    340:  * return: NULL not found call, !=NULL return call
                    341:  */
                    342: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
                    343: /*
                    344:  * rpc_srv_execCall() Execute registered call from RPC server
                    345:  * @call = Register RPC call
                    346:  * @rpc = IN RPC call structure
1.4       misho     347:  * @args = IN RPC calling arguments from RPC client
1.1       misho     348:  * return: -1 error, !=-1 ok
                    349:  */
1.2       misho     350: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, 
1.4       misho     351:                array_t * __restrict args);
1.1       misho     352: 
                    353: 
                    354: /*
1.3       misho     355:  * rpc_srv_allocVars() Allocate array for call variables, 
                    356:                                if already allocated memory for RPC call reallocate used space
1.1       misho     357:  * @call = RPC function call
1.3       misho     358:  * @varnum = Number of variables, if ==0 free previous allocated variables
                    359:  * return: -1 error, !=-1 return varnum value
1.1       misho     360:  */
1.3       misho     361: inline int rpc_srv_allocVars(rpc_func_t * __restrict call, int varnum);
1.1       misho     362: /*
1.4       misho     363:  * rpc_srv_destroyVars() Destroy variables of array & array
                    364:  * @call = RPC function call
                    365:  * return: -1 error, !=-1 Returne remained variables
                    366:  */
                    367: inline int rpc_srv_destroyVars(rpc_func_t * __restrict call);
                    368: /*
                    369:  * rpc_srv_freeVals() Clean values from variables of array
1.1       misho     370:  * @call = RPC function call
1.4       misho     371:  * return: -1 error, !=-1 Returned number of cleaned variables
1.1       misho     372:  */
1.4       misho     373: inline int rpc_srv_freeVals(rpc_func_t * __restrict call);
1.1       misho     374: /*
1.3       misho     375:  * rpc_srv_copyVars() Copy variables for RPC call to new variable array
1.1       misho     376:  * @call = RPC function call
1.3       misho     377:  * @newvars = New allocated variables array, must be free after use
1.1       misho     378:  * return: -1 error, !=-1 Returned number of copied RPC variables
                    379:  */
1.4       misho     380: inline int rpc_srv_copyVars(rpc_func_t * __restrict call, array_t ** __restrict newvars);
1.1       misho     381: /*
1.3       misho     382:  * rpc_srv_getVars() Get variables array for RPC call
1.1       misho     383:  * @call = RPC function call
1.3       misho     384:  * @vars = Returned variables array, may be NULL
1.1       misho     385:  * return: -1 error, !=-1 Number of returned variables
                    386:  */
1.4       misho     387: inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);
1.1       misho     388: 
                    389: 
1.2       misho     390: /*
                    391:  * rpc_srv_blobCreate() Create map blob to memory region and return object
                    392:  * @srv = RPC Server instance
                    393:  * @len = BLOB length object
                    394:  * return: NULL error or !=NULL allocated BLOB object
                    395:  */
                    396: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
                    397: /*
                    398:  * rpc_srv_blobMap() Map blob to memory region 
                    399:  * @srv = RPC Server instance
                    400:  * @blob = Map to this BLOB element
                    401:  * return: -1 error or 0 ok
                    402:  */
                    403: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    404: /*
                    405:  * rpc_srv_blobUnmap() Unmap blob memory region 
                    406:  * @blob = Mapped BLOB element
                    407:  * return: none
                    408:  */
                    409: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
                    410: /*
                    411:  * rpc_srv_blobFree() Free blob from disk & memory
                    412:  * @srv = RPC Server instance
                    413:  * @blob = Mapped BLOB element
                    414:  * return: -1 error or 0 ok
                    415:  */
                    416: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    417: 
                    418: /*
                    419:  * rpc_srv_registerBLOB() Register new BLOB to server
                    420:  * @srv = RPC Server instance
                    421:  * @len = BLOB length
                    422:  * return: NULL error or new registered BLOB
                    423:  */
                    424: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
                    425: /*
                    426:  * rpc_srv_unregisterBLOB() Unregister BLOB from server
                    427:  * @srv = RPC Server instance
                    428:  * @var = BLOB Variable for unregister
                    429:  * return: -1 error, 0 not found call, 1 unregister ok
                    430:  */
                    431: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    432: /*
                    433:  * rpc_srv_getBLOB() Get registered BLOB 
                    434:  * @srv = RPC Server instance
                    435:  * @var = hash for variable
                    436:  * return: NULL not found, !=NULL return blob var
                    437:  */
                    438: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    439: 
                    440: /*
                    441:  * rpc_srv_sendBLOB() Send mapped BLOB to client
                    442:  * @cli = Client instance
                    443:  * @blob = Mapped BLOB element
                    444:  * return: -1 error, 0 ok
                    445:  */
                    446: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    447: /*
                    448:  * rpc_srv_recvBLOB() Receive BLOB from client
                    449:  * @cli = Client instance
                    450:  * @blob = Mapped BLOB element
                    451:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
                    452:  */
                    453: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    454: 
1.4       misho     455: /* CLIENT part of functions */
                    456: 
1.2       misho     457: /*
                    458:  * rpc_cli_sendBLOB() Send BLOB to server
                    459:  * @cli = Client instance
                    460:  * @var = BLOB variable
                    461:  * @data = BLOB data
                    462:  * return: -1 error, 0 ok, 1 remote error
                    463:  */
1.4       misho     464: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
1.2       misho     465: /*
                    466:  * rpc_cli_recvBLOB() Receive BLOB from server
                    467:  * @cli = Client instance
                    468:  * @var = BLOB variable
                    469:  * @data = BLOB data, must be free after use!
                    470:  * return: -1 error, 0 ok, 1 remote error
                    471:  */
1.4       misho     472: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     473: /*
                    474:  * rpc_cli_delBLOB() Delete BLOB from server
                    475:  * @cli = Client instance
                    476:  * @var = BLOB variable
                    477:  * return: -1 error, 0 ok, 1 remote error
                    478:  */
1.4       misho     479: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2       misho     480: /*
                    481:  * rpc_cli_getBLOB() Receive BLOB from server and Delete after that.
                    482:  * @cli = Client instance
                    483:  * @var = BLOB variable
                    484:  * @data = BLOB data, must be free after use!
                    485:  * return: -1 error, 0 ok, >0 remote error
                    486:  */
1.4       misho     487: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     488: 
                    489: 
                    490: 
1.1       misho     491: /* RPC Client side functions */
                    492: 
                    493: /*
                    494:  * rpc_cli_openClient() Connect to RPC Server
                    495:  * @ProgID = ProgramID for RPC session request
                    496:  * @ProcID = ProcessID for RPC session request
1.4       misho     497:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.1       misho     498:  * @family = Family socket type, AF_INET or AF_INET6
                    499:  * @csHost = Host name or IP address for bind server
                    500:  * @Port = Port for bind server, if Port == 0 default port is selected
                    501:  * return: NULL == error or !=NULL connection to RPC server established
                    502:  */
1.4       misho     503: rpc_cli_t *rpc_cli_openClient(u_int ProgID, u_int ProcID, int netBuf, 
1.3       misho     504:                u_short family, const char *csHost, u_short Port);
1.1       misho     505: /*
                    506:  * rpc_cli_closeClient() Close connection to RPC server and free resources
                    507:  * @cli = RPC Client session
                    508:  * return: none
                    509:  */
                    510: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
                    511: /*
                    512:  * rpc_cli_execCall() Execute RPC call
                    513:  * @cli = RPC Client session
                    514:  * @csModule = Module name, if NULL self binary
                    515:  * @csFunc = Function name for execute
1.3       misho     516:  * @in_vars = IN RPC call array of rpc values
1.4       misho     517:  * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
1.1       misho     518:  * return: -1 error or != -1 ok result
                    519:  */
1.4       misho     520: int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, 
                    521:                array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.1       misho     522: /*
1.4       misho     523:  * rpc_cli_freeVals() Free ait_val_t array returned from RPC call
                    524:  * @vars = Variable array
1.1       misho     525:  * return: none
                    526:  */
1.4       misho     527: inline void rpc_cli_freeVals(array_t ** __restrict vars);
                    528: /*
                    529:  * rpc_cli_allocVals() Allocate ait_val_t array for RPC call
                    530:  * @args = Number of arguments
                    531:  * return: =NULL error or !=NULL allocated array
                    532:  */
                    533: inline array_t *rpc_cli_allocVals(unsigned short args);
1.1       misho     534: 
                    535: 
1.2       misho     536: /*
                    537:  * rpc_cli_openBLOBClient() Connect to BLOB Server
                    538:  * @rpccli = RPC Client session
                    539:  * @Port = Port for bind server, if Port == 0 default port is selected
                    540:  * return: NULL == error or !=NULL connection to BLOB server established
                    541:  */
                    542: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
                    543: /*
                    544:  * rpc_cli_closeBLOBClient() Close connection to BLOB server and free resources
                    545:  * @cli = BLOB Client session
                    546:  * return: none
                    547:  */
                    548: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
                    549: 
                    550: 
1.1       misho     551: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>