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

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.7.2.2 ! misho       6: * $Id: aitrpc.h,v 1.7.2.1 2012/05/11 08:46:41 misho Exp $
1.1       misho       7: *
1.2       misho       8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
1.6       misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.2       misho      16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
1.1       misho      46: #ifndef __AITRPC_H
                     47: #define __AITRPC_H
                     48: 
                     49: 
                     50: #include <assert.h>
                     51: #include <stdlib.h>
                     52: #include <string.h>
1.6       misho      53: #include <errno.h>
1.1       misho      54: #include <sys/types.h>
                     55: #include <sys/param.h>
1.2       misho      56: #if !defined(__NetBSD__)
1.1       misho      57: #include <sys/limits.h>
1.2       misho      58: #endif
1.1       misho      59: #include <sys/socket.h>
1.4       misho      60: #include <aitio.h>
1.6       misho      61: #include <aitsched.h>
1.1       misho      62: 
                     63: 
1.6       misho      64: #define RPC_VERSION            3
1.1       misho      65: #define RPC_DEFPORT            2611
                     66: 
1.6       misho      67: /* RPC call request flags */
                     68: 
                     69: #define RPC_REPLY              0x0
                     70: #define RPC_NOREPLY            0x1
1.1       misho      71: 
                     72: /* RPC builtin registed calls */
                     73: 
1.2       misho      74: #define CALL_BLOBSHUTDOWN      "rpcBLOBServerShutdown"
                     75: #define CALL_BLOBCLIENTS       "rpcBLOBServerClients"
                     76: #define CALL_BLOBVARS          "rpcBLOBServerVars"
                     77: #define CALL_BLOBSTATE         "rpcBLOBServerState"
                     78: 
                     79: #define CALL_SRVSHUTDOWN       "rpcServerShutdown"
1.1       misho      80: #define CALL_SRVCLIENTS                "rpcServerClients"
                     81: #define CALL_SRVCALLS          "rpcServerCalls"
                     82: #define CALL_SRVSESSIONS       "rpcServerSessions"
                     83: 
                     84: 
                     85: /* RPC types */
                     86: 
                     87: typedef enum {
1.4       misho      88:        disable, enable, running, kill,         /* for blob.state */
1.6       misho      89:        ok, error, no,                          /* for blob reply */
1.4       misho      90:        get, set, unset                         /* for blob request */
1.2       misho      91: } cmd_type_t;
                     92: 
1.1       misho      93: 
1.4       misho      94: #define RPC_CALLBACK_CHECK_INPUT(_f)   do { \
                     95:                                                assert((_f)); \
                     96:                                                if (!(_f)) { \
1.6       misho      97:                                                        rpc_SetErr(EINVAL, \
                     98:                                                                        "Invalid callback parameters ..."); \
1.2       misho      99:                                                        return -1; \
                    100:                                                } \
                    101:                                        } while (0)
1.4       misho     102: #define RPC_CALLBACK_CHK_ARGS(_f, _n)  do { \
                    103:                                                RPC_CALLBACK_CHECK_INPUT((_f)); \
1.5       misho     104:                                                if ((_f) && io_arraySize((_f)->func_vars) < _n) { \
1.6       misho     105:                                                        rpc_SetErr(EINVAL, \
                    106:                                                                        "Not enough number of arguments!"); \
1.1       misho     107:                                                        return -1; \
                    108:                                                } \
1.2       misho     109:                                        } while (0)
1.1       misho     110: 
                    111: 
                    112: /* RPC session identification */
                    113: 
                    114: typedef struct {
                    115:        uint8_t         sess_version;
1.6       misho     116:        uint8_t         sess_timeout;
1.1       misho     117:        uint32_t        sess_program;
                    118:        uint32_t        sess_process;
                    119: } __packed rpc_sess_t;
                    120: 
                    121: 
                    122: /* Server managment RPC functions ... */
                    123: 
1.6       misho     124: /* RPC function registration element! */
1.1       misho     125: typedef struct tagRPCFunc {
                    126:        uint16_t                func_tag;
                    127:        uint32_t                func_hash;
1.6       misho     128:        ait_val_t               func_file;
                    129:        ait_val_t               func_name;
1.1       misho     130: 
1.4       misho     131:        array_t                 *func_vars;
1.1       misho     132: 
1.2       misho     133:        void                    *func_parent;
1.1       misho     134:        struct tagRPCFunc       *func_next;
                    135: } rpc_func_t;
                    136: 
                    137: 
                    138: /* Network RPC packet - Client request */
                    139: 
                    140: struct tagRPCCall {
                    141:        rpc_sess_t      call_session;
1.6       misho     142: 
1.7       misho     143:        uint16_t        call_len;
                    144: 
1.1       misho     145:        uint16_t        call_tag;
                    146:        uint32_t        call_hash;
1.4       misho     147:        uint16_t        call_argc;
1.1       misho     148: 
1.6       misho     149:        union {
                    150:                struct {
                    151:                        uint64_t        flags;
                    152:                }       call_req;
                    153:                struct {
                    154:                        int32_t         ret;
                    155:                        int32_t         eno;
                    156:                }       call_rep;
                    157:        };
1.1       misho     158: 
1.6       misho     159:        uint16_t        call_crc;
1.1       misho     160: } __packed;
                    161: 
1.2       misho     162: /* Network BLOB packet - Header */
                    163: 
                    164: struct tagBLOBHdr {
                    165:        rpc_sess_t      hdr_session;
                    166:        uint8_t         hdr_cmd;
                    167:        uint32_t        hdr_var;
                    168:        uint32_t        hdr_len;
                    169:        uint32_t        hdr_ret;
1.6       misho     170:        uint16_t        hdr_crc;
                    171:        uint8_t         hdr_pad;
1.2       misho     172: } __packed;
                    173: 
1.1       misho     174: /* Network RPC client & server elements */
                    175: 
                    176: typedef struct {
1.5       misho     177:        io_sockaddr_t   cli_sa;         // host info
1.3       misho     178:        int             cli_sock;       // socket fd
1.1       misho     179:        pthread_t       cli_tid;        // TID of thread
                    180: 
                    181:        void            *cli_parent;    // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
1.4       misho     182:        int             cli_netbuf;     // size of network buffer size
1.1       misho     183: } rpc_cli_t;
                    184: 
1.2       misho     185: 
1.6       misho     186: /* BLOB registration element! */
1.2       misho     187: typedef struct tagBLOB {
                    188:        uint32_t        blob_var;
                    189: 
                    190:        size_t          blob_len;       // size of allocated BLOB data
                    191:        void            *blob_data;     // BLOB data
                    192: 
                    193:        struct tagBLOB  *blob_next;
                    194: } rpc_blob_t;
                    195: 
1.1       misho     196: typedef struct {
1.6       misho     197:        rpc_sess_t              srv_session;    // RPC session registration info
                    198:        int                     srv_numcli;     // maximum concurent client connections
                    199:        int                     srv_netbuf;     // size of network buffer size
1.1       misho     200: 
1.6       misho     201:        rpc_cli_t               srv_server;     // RPC server socket
                    202:        rpc_cli_t               *srv_clients;   // connected rpc client sockets
1.2       misho     203: 
1.6       misho     204:        rpc_func_t              *srv_funcs;     // registered functions list
1.2       misho     205: 
1.6       misho     206:        cmd_type_t              srv_kill;
1.2       misho     207: 
                    208:        struct {
1.3       misho     209:                cmd_type_t      state;          // BLOB server state: ==0 disable | !=0 enable
1.6       misho     210:                ait_val_t       dir;
1.2       misho     211: 
                    212:                rpc_cli_t       server;         // BLOB server socket
                    213:                rpc_cli_t       *clients;       // connected blob client sockets
1.1       misho     214: 
1.2       misho     215:                rpc_blob_t      *blobs;         // registered blob variables list
1.6       misho     216:        }                       srv_blob;
1.1       misho     217: } rpc_srv_t;
                    218: 
                    219: 
1.2       misho     220: /* 
1.6       misho     221:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
                    222:  *
1.2       misho     223:  * @arg1 = current execution RPC call function
                    224:  * @arg2 = number of items in input array from call request
                    225:  * @arg3 = input array with values from RPC call execution request
                    226:  * return: -1 error or >-1 success execution
                    227:  */
1.4       misho     228: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
1.1       misho     229: 
                    230: 
                    231: // -----------------------------------------------------------------------
                    232: 
                    233: /* Error support functions */
                    234: 
1.3       misho     235: // rpc_GetErrno() Get error code of last operation
                    236: inline int rpc_GetErrno();
                    237: // rpc_GetError() Get error text of last operation
                    238: inline const char *rpc_GetError();
1.1       misho     239: 
                    240: 
1.5       misho     241: /*
1.6       misho     242:  * rpc_chkPktSession() - Check session in RPC packet
                    243:  *
1.5       misho     244:  * @p = packet session
                    245:  * @s = active session
                    246:  * return: -1 error or 0 ok
                    247:  */
                    248: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    249: /*
1.6       misho     250:  * rpc_addPktSession() - Add session into RPC packet
                    251:  *
1.5       misho     252:  * @p = packet session
                    253:  * @s = active session
                    254:  * return: -1 error or 0 ok
                    255:  */
                    256: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    257: 
                    258: 
1.1       misho     259: /* RPC Server side functions */
                    260: 
                    261: /*
1.6       misho     262:  * rpc_srv_initServer() - Init & create RPC Server
                    263:  *
1.1       misho     264:  * @regProgID = ProgramID for authentication & recognition
                    265:  * @regProcID = ProcessID for authentication & recognition
                    266:  * @concurentClients = Concurent clients at same time to this server
1.4       misho     267:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     268:  * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
                    269:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     270:  * @Port = Port for bind server, if Port == 0 default port is selected
                    271:  * return: NULL == error or !=NULL bind and created RPC server instance
                    272:  */
                    273: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients, 
1.4       misho     274:                int netBuf, u_short family, const char *csHost, u_short Port);
1.1       misho     275: /*
1.6       misho     276:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
                    277:  *
1.5       misho     278:  * @psrv = RPC Server instance
1.1       misho     279:  * return: none
                    280:  */
1.5       misho     281: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1       misho     282: /*
1.6       misho     283:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
                    284:  *
1.1       misho     285:  * @srv = RPC Server instance
                    286:  * return: -1 error or 0 ok, infinite loop ...
                    287:  */
1.4       misho     288: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
                    289: #define rpc_srv_execServer(_srv, _sync)        do { assert((_srv)); pthread_t __tid; \
                    290:                                                pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    291:                                                                rpc_srv_loopServer, (_srv)); \
                    292:                                                if ((_sync)) \
                    293:                                                        pthread_join(__tid, (void**) (_sync)); \
                    294:                                                else \
                    295:                                                        pthread_detach(__tid); \
                    296:                                        } while (0)
1.1       misho     297: 
                    298: /*
1.6       misho     299:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
                    300:  *
1.3       misho     301:  * @srv = RPC server instance
1.2       misho     302:  * @Port = Port for bind server, if Port == 0 default port is selected
                    303:  * @diskDir = Disk place for BLOB file objects
                    304:  * return: -1 == error or 0 bind and created BLOB server instance
                    305:  */
                    306: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
                    307: /*
1.6       misho     308:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
                    309:  *
1.2       misho     310:  * @srv = RPC Server instance
                    311:  * return: none
                    312:  */
                    313: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
                    314: /*
1.6       misho     315:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
                    316:  *
1.2       misho     317:  * @srv = RPC Server instance
                    318:  * return: -1 error or 0 ok, infinite loop ...
                    319:  */
1.4       misho     320: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
                    321: #define rpc_srv_execBLOBServer(_srv)   do { assert((_srv)); pthread_t __tid; \
                    322:                                                if ((_srv)->srv_blob.state == enable) { \
                    323:                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    324:                                                                        rpc_srv_loopBLOB, (_srv)); \
                    325:                                                        pthread_detach(__tid); \
                    326:                                                        (_srv)->srv_blob.state = running; \
                    327:                                                } \
                    328:                                        } while (0)
1.2       misho     329: 
                    330: /*
1.6       misho     331:  * rpc_srv_registerCall() - Register call to RPC server
                    332:  *
1.1       misho     333:  * @srv = RPC Server instance
                    334:  * @csModule = Module name, if NULL self binary
                    335:  * @csFunc = Function name
1.2       misho     336:  * @args = Number of return function arguments, use for restriction case!
1.1       misho     337:  * return: -1 error or 0 register ok
                    338:  */
                    339: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, 
1.4       misho     340:                unsigned short args);
1.1       misho     341: /*
1.6       misho     342:  * rpc_srv_unregisterCall() - Unregister call from RPC server
                    343:  *
1.1       misho     344:  * @srv = RPC Server instance
                    345:  * @csModule = Module name, if NULL self binary
                    346:  * @csFunc = Function name
                    347:  * return: -1 error, 0 not found call, 1 unregister ok
                    348:  */
                    349: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    350: /*
1.6       misho     351:  * rpc_srv_getFunc() - Get registered call from RPC server by Name
                    352:  *
1.1       misho     353:  * @srv = RPC Server instance
                    354:  * @csModule = Module name, if NULL self binary
                    355:  * @csFunc = Function name
                    356:  * return: NULL not found call, !=NULL return call
                    357:  */
                    358: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    359: /*
1.6       misho     360:  * rpc_srv_getCall() - Get registered call from RPC server
                    361:  *
1.1       misho     362:  * @srv = RPC Server instance
                    363:  * @tag = tag for function
                    364:  * @hash = hash for function
                    365:  * return: NULL not found call, !=NULL return call
                    366:  */
                    367: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
                    368: /*
1.6       misho     369:  * rpc_srv_execCall() - Execute registered call from RPC server
                    370:  *
1.1       misho     371:  * @call = Register RPC call
                    372:  * @rpc = IN RPC call structure
1.4       misho     373:  * @args = IN RPC calling arguments from RPC client
1.1       misho     374:  * return: -1 error, !=-1 ok
                    375:  */
1.2       misho     376: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, 
1.4       misho     377:                array_t * __restrict args);
1.1       misho     378: 
                    379: 
                    380: /*
1.6       misho     381:  * rpc_srv_getVars() - Get variables array for RPC call
                    382:  *
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: /*
1.6       misho     391:  * rpc_srv_blobCreate() - Create map blob to memory region and return object
                    392:  *
1.2       misho     393:  * @srv = RPC Server instance
                    394:  * @len = BLOB length object
                    395:  * return: NULL error or !=NULL allocated BLOB object
                    396:  */
                    397: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
                    398: /*
1.6       misho     399:  * rpc_srv_blobMap() - Map blob to memory region 
                    400:  *
1.2       misho     401:  * @srv = RPC Server instance
                    402:  * @blob = Map to this BLOB element
                    403:  * return: -1 error or 0 ok
                    404:  */
                    405: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    406: /*
1.6       misho     407:  * rpc_srv_blobUnmap() - Unmap blob memory region 
                    408:  *
1.2       misho     409:  * @blob = Mapped BLOB element
                    410:  * return: none
                    411:  */
                    412: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
                    413: /*
1.6       misho     414:  * rpc_srv_blobFree() - Free blob from disk & memory
                    415:  *
1.2       misho     416:  * @srv = RPC Server instance
                    417:  * @blob = Mapped BLOB element
                    418:  * return: -1 error or 0 ok
                    419:  */
                    420: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    421: 
                    422: /*
1.6       misho     423:  * rpc_srv_registerBLOB() - Register new BLOB to server
                    424:  *
1.2       misho     425:  * @srv = RPC Server instance
                    426:  * @len = BLOB length
                    427:  * return: NULL error or new registered BLOB
                    428:  */
                    429: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
                    430: /*
1.6       misho     431:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
                    432:  *
1.2       misho     433:  * @srv = RPC Server instance
                    434:  * @var = BLOB Variable for unregister
                    435:  * return: -1 error, 0 not found call, 1 unregister ok
                    436:  */
                    437: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    438: /*
1.6       misho     439:  * rpc_srv_getBLOB() - Get registered BLOB 
                    440:  *
1.2       misho     441:  * @srv = RPC Server instance
                    442:  * @var = hash for variable
                    443:  * return: NULL not found, !=NULL return blob var
                    444:  */
                    445: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    446: 
                    447: /*
1.6       misho     448:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
                    449:  *
1.2       misho     450:  * @cli = Client instance
                    451:  * @blob = Mapped BLOB element
                    452:  * return: -1 error, 0 ok
                    453:  */
                    454: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    455: /*
1.6       misho     456:  * rpc_srv_recvBLOB() - Receive BLOB from client
                    457:  *
1.2       misho     458:  * @cli = Client instance
                    459:  * @blob = Mapped BLOB element
                    460:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
                    461:  */
                    462: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    463: 
1.4       misho     464: /* CLIENT part of functions */
                    465: 
1.2       misho     466: /*
1.6       misho     467:  * rpc_cli_sendBLOB() - Send BLOB to server
                    468:  *
1.2       misho     469:  * @cli = Client instance
                    470:  * @var = BLOB variable
                    471:  * @data = BLOB data
                    472:  * return: -1 error, 0 ok, 1 remote error
                    473:  */
1.4       misho     474: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
1.2       misho     475: /*
1.6       misho     476:  * rpc_cli_recvBLOB() - Receive BLOB from server
                    477:  *
1.2       misho     478:  * @cli = Client instance
                    479:  * @var = BLOB variable
                    480:  * @data = BLOB data, must be free after use!
                    481:  * return: -1 error, 0 ok, 1 remote error
                    482:  */
1.4       misho     483: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     484: /*
1.6       misho     485:  * rpc_cli_delBLOB() - Delete BLOB from server
                    486:  *
1.2       misho     487:  * @cli = Client instance
                    488:  * @var = BLOB variable
                    489:  * return: -1 error, 0 ok, 1 remote error
                    490:  */
1.4       misho     491: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2       misho     492: /*
1.6       misho     493:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
                    494:  *
1.2       misho     495:  * @cli = Client instance
                    496:  * @var = BLOB variable
                    497:  * @data = BLOB data, must be free after use!
                    498:  * return: -1 error, 0 ok, >0 remote error
                    499:  */
1.6       misho     500: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
                    501:                void ** __restrict data);
1.2       misho     502: 
                    503: 
1.6       misho     504: /*
                    505:  * rpc_calcHashes() - Calculate hashes for RPC call
                    506:  *
                    507:  * @func = function
                    508:  * @csModule = Module name, if NULL self binary
                    509:  * @csFunc = Function name
                    510:  * return: -1 error or 0 ok
                    511:  */
                    512: int rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc);
                    513: 
1.2       misho     514: 
1.1       misho     515: /* RPC Client side functions */
                    516: 
                    517: /*
1.6       misho     518:  * rpc_cli_openClient() - Connect to RPC Server
                    519:  *
1.1       misho     520:  * @ProgID = ProgramID for RPC session request
                    521:  * @ProcID = ProcessID for RPC session request
1.4       misho     522:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.6       misho     523:  * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
1.1       misho     524:  * @family = Family socket type, AF_INET or AF_INET6
                    525:  * @csHost = Host name or IP address for bind server
                    526:  * @Port = Port for bind server, if Port == 0 default port is selected
                    527:  * return: NULL == error or !=NULL connection to RPC server established
                    528:  */
1.6       misho     529: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf, 
                    530:                unsigned char Timeout, unsigned short family, 
                    531:                const char *csHost, unsigned short Port);
1.1       misho     532: /*
1.6       misho     533:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
                    534:  *
1.1       misho     535:  * @cli = RPC Client session
                    536:  * return: none
                    537:  */
                    538: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
                    539: /*
1.6       misho     540:  * rpc_cli_execCall() - Execute RPC call
                    541:  *
1.1       misho     542:  * @cli = RPC Client session
1.7       misho     543:  * @noreply = We not want RPC reply
1.1       misho     544:  * @csModule = Module name, if NULL self binary
                    545:  * @csFunc = Function name for execute
1.3       misho     546:  * @in_vars = IN RPC call array of rpc values
1.4       misho     547:  * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
1.1       misho     548:  * return: -1 error or != -1 ok result
                    549:  */
1.7       misho     550: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, const char *csModule, const char *csFunc, 
1.4       misho     551:                array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.1       misho     552: 
                    553: 
1.2       misho     554: /*
1.6       misho     555:  * rpc_cli_openBLOBClient() - Connect to BLOB Server
                    556:  *
1.2       misho     557:  * @rpccli = RPC Client session
                    558:  * @Port = Port for bind server, if Port == 0 default port is selected
                    559:  * return: NULL == error or !=NULL connection to BLOB server established
                    560:  */
                    561: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
                    562: /*
1.6       misho     563:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
                    564:  *
1.2       misho     565:  * @cli = BLOB Client session
                    566:  * return: none
                    567:  */
                    568: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
                    569: 
                    570: 
1.1       misho     571: #endif

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