Annotation of libaitrpc/inc/aitrpc.h, revision 1.5.2.3

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

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