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

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.6     ! misho       6: * $Id: aitrpc.h,v 1.5.2.8 2012/03/15 00:44:23 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.1       misho     143:        uint16_t        call_tag;
                    144:        uint32_t        call_hash;
1.4       misho     145:        uint16_t        call_argc;
1.1       misho     146: 
1.6     ! misho     147:        union {
        !           148:                struct {
        !           149:                        uint64_t        flags;
        !           150:                }       call_req;
        !           151:                struct {
        !           152:                        int32_t         ret;
        !           153:                        int32_t         eno;
        !           154:                }       call_rep;
        !           155:        };
1.1       misho     156: 
1.6     ! misho     157:        uint16_t        call_crc;
1.1       misho     158: } __packed;
                    159: 
1.2       misho     160: /* Network BLOB packet - Header */
                    161: 
                    162: struct tagBLOBHdr {
                    163:        rpc_sess_t      hdr_session;
                    164:        uint8_t         hdr_cmd;
                    165:        uint32_t        hdr_var;
                    166:        uint32_t        hdr_len;
                    167:        uint32_t        hdr_ret;
1.6     ! misho     168:        uint16_t        hdr_crc;
        !           169:        uint8_t         hdr_pad;
1.2       misho     170: } __packed;
                    171: 
1.1       misho     172: /* Network RPC client & server elements */
                    173: 
                    174: typedef struct {
1.5       misho     175:        io_sockaddr_t   cli_sa;         // host info
1.3       misho     176:        int             cli_sock;       // socket fd
1.1       misho     177:        pthread_t       cli_tid;        // TID of thread
                    178: 
                    179:        void            *cli_parent;    // pointer to parent rpc_srv_t for server or to rpc_sess_t for client
1.4       misho     180:        int             cli_netbuf;     // size of network buffer size
1.1       misho     181: } rpc_cli_t;
                    182: 
1.2       misho     183: 
1.6     ! misho     184: /* BLOB registration element! */
1.2       misho     185: typedef struct tagBLOB {
                    186:        uint32_t        blob_var;
                    187: 
                    188:        size_t          blob_len;       // size of allocated BLOB data
                    189:        void            *blob_data;     // BLOB data
                    190: 
                    191:        struct tagBLOB  *blob_next;
                    192: } rpc_blob_t;
                    193: 
1.1       misho     194: typedef struct {
1.6     ! misho     195:        rpc_sess_t              srv_session;    // RPC session registration info
        !           196:        int                     srv_numcli;     // maximum concurent client connections
        !           197:        int                     srv_netbuf;     // size of network buffer size
1.1       misho     198: 
1.6     ! misho     199:        rpc_cli_t               srv_server;     // RPC server socket
        !           200:        rpc_cli_t               *srv_clients;   // connected rpc client sockets
1.2       misho     201: 
1.6     ! misho     202:        rpc_func_t              *srv_funcs;     // registered functions list
1.2       misho     203: 
1.6     ! misho     204:        pthread_mutex_t         srv_mtx;
        !           205:        cmd_type_t              srv_kill;
1.2       misho     206: 
                    207:        struct {
1.3       misho     208:                cmd_type_t      state;          // BLOB server state: ==0 disable | !=0 enable
1.6     ! misho     209:                ait_val_t       dir;
1.2       misho     210: 
                    211:                rpc_cli_t       server;         // BLOB server socket
                    212:                rpc_cli_t       *clients;       // connected blob client sockets
1.1       misho     213: 
1.2       misho     214:                rpc_blob_t      *blobs;         // registered blob variables list
1.1       misho     215: 
1.2       misho     216:                pthread_mutex_t mtx;
1.6     ! misho     217:        }                       srv_blob;
1.1       misho     218: } rpc_srv_t;
                    219: 
                    220: 
1.2       misho     221: /* 
1.6     ! misho     222:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
        !           223:  *
1.2       misho     224:  * @arg1 = current execution RPC call function
                    225:  * @arg2 = number of items in input array from call request
                    226:  * @arg3 = input array with values from RPC call execution request
                    227:  * return: -1 error or >-1 success execution
                    228:  */
1.4       misho     229: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
1.1       misho     230: 
                    231: 
                    232: // -----------------------------------------------------------------------
                    233: 
                    234: /* Error support functions */
                    235: 
1.3       misho     236: // rpc_GetErrno() Get error code of last operation
                    237: inline int rpc_GetErrno();
                    238: // rpc_GetError() Get error text of last operation
                    239: inline const char *rpc_GetError();
1.1       misho     240: 
                    241: 
1.5       misho     242: /*
1.6     ! misho     243:  * rpc_chkPktSession() - Check session in RPC packet
        !           244:  *
1.5       misho     245:  * @p = packet session
                    246:  * @s = active session
                    247:  * return: -1 error or 0 ok
                    248:  */
                    249: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    250: /*
1.6     ! misho     251:  * rpc_addPktSession() - Add session into RPC packet
        !           252:  *
1.5       misho     253:  * @p = packet session
                    254:  * @s = active session
                    255:  * return: -1 error or 0 ok
                    256:  */
                    257: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    258: 
                    259: 
1.1       misho     260: /* RPC Server side functions */
                    261: 
                    262: /*
1.6     ! misho     263:  * rpc_srv_initServer() - Init & create RPC Server
        !           264:  *
1.1       misho     265:  * @regProgID = ProgramID for authentication & recognition
                    266:  * @regProcID = ProcessID for authentication & recognition
                    267:  * @concurentClients = Concurent clients at same time to this server
1.4       misho     268:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     269:  * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
                    270:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     271:  * @Port = Port for bind server, if Port == 0 default port is selected
                    272:  * return: NULL == error or !=NULL bind and created RPC server instance
                    273:  */
                    274: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients, 
1.4       misho     275:                int netBuf, u_short family, const char *csHost, u_short Port);
1.1       misho     276: /*
1.6     ! misho     277:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
        !           278:  *
1.5       misho     279:  * @psrv = RPC Server instance
1.1       misho     280:  * return: none
                    281:  */
1.5       misho     282: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1       misho     283: /*
1.6     ! misho     284:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
        !           285:  *
1.1       misho     286:  * @srv = RPC Server instance
                    287:  * return: -1 error or 0 ok, infinite loop ...
                    288:  */
1.4       misho     289: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
                    290: #define rpc_srv_execServer(_srv, _sync)        do { assert((_srv)); pthread_t __tid; \
                    291:                                                pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    292:                                                                rpc_srv_loopServer, (_srv)); \
                    293:                                                if ((_sync)) \
                    294:                                                        pthread_join(__tid, (void**) (_sync)); \
                    295:                                                else \
                    296:                                                        pthread_detach(__tid); \
                    297:                                        } while (0)
1.1       misho     298: 
                    299: /*
1.6     ! misho     300:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
        !           301:  *
1.3       misho     302:  * @srv = RPC server instance
1.2       misho     303:  * @Port = Port for bind server, if Port == 0 default port is selected
                    304:  * @diskDir = Disk place for BLOB file objects
                    305:  * return: -1 == error or 0 bind and created BLOB server instance
                    306:  */
                    307: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
                    308: /*
1.6     ! misho     309:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
        !           310:  *
1.2       misho     311:  * @srv = RPC Server instance
                    312:  * return: none
                    313:  */
                    314: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
                    315: /*
1.6     ! misho     316:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
        !           317:  *
1.2       misho     318:  * @srv = RPC Server instance
                    319:  * return: -1 error or 0 ok, infinite loop ...
                    320:  */
1.4       misho     321: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
                    322: #define rpc_srv_execBLOBServer(_srv)   do { assert((_srv)); pthread_t __tid; \
                    323:                                                if ((_srv)->srv_blob.state == enable) { \
                    324:                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    325:                                                                        rpc_srv_loopBLOB, (_srv)); \
                    326:                                                        pthread_detach(__tid); \
                    327:                                                        (_srv)->srv_blob.state = running; \
                    328:                                                } \
                    329:                                        } while (0)
1.2       misho     330: 
                    331: /*
1.6     ! misho     332:  * rpc_srv_registerCall() - Register call to RPC server
        !           333:  *
1.1       misho     334:  * @srv = RPC Server instance
                    335:  * @csModule = Module name, if NULL self binary
                    336:  * @csFunc = Function name
1.2       misho     337:  * @args = Number of return function arguments, use for restriction case!
1.1       misho     338:  * return: -1 error or 0 register ok
                    339:  */
                    340: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, 
1.4       misho     341:                unsigned short args);
1.1       misho     342: /*
1.6     ! misho     343:  * rpc_srv_unregisterCall() - Unregister call from RPC server
        !           344:  *
1.1       misho     345:  * @srv = RPC Server instance
                    346:  * @csModule = Module name, if NULL self binary
                    347:  * @csFunc = Function name
                    348:  * return: -1 error, 0 not found call, 1 unregister ok
                    349:  */
                    350: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    351: /*
1.6     ! misho     352:  * rpc_srv_getFunc() - Get registered call from RPC server by Name
        !           353:  *
1.1       misho     354:  * @srv = RPC Server instance
                    355:  * @csModule = Module name, if NULL self binary
                    356:  * @csFunc = Function name
                    357:  * return: NULL not found call, !=NULL return call
                    358:  */
                    359: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    360: /*
1.6     ! misho     361:  * rpc_srv_getCall() - Get registered call from RPC server
        !           362:  *
1.1       misho     363:  * @srv = RPC Server instance
                    364:  * @tag = tag for function
                    365:  * @hash = hash for function
                    366:  * return: NULL not found call, !=NULL return call
                    367:  */
                    368: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
                    369: /*
1.6     ! misho     370:  * rpc_srv_execCall() - Execute registered call from RPC server
        !           371:  *
1.1       misho     372:  * @call = Register RPC call
                    373:  * @rpc = IN RPC call structure
1.4       misho     374:  * @args = IN RPC calling arguments from RPC client
1.1       misho     375:  * return: -1 error, !=-1 ok
                    376:  */
1.2       misho     377: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, 
1.4       misho     378:                array_t * __restrict args);
1.1       misho     379: 
                    380: 
                    381: /*
1.6     ! misho     382:  * rpc_srv_getVars() - Get variables array for RPC call
        !           383:  *
1.1       misho     384:  * @call = RPC function call
1.3       misho     385:  * @vars = Returned variables array, may be NULL
1.1       misho     386:  * return: -1 error, !=-1 Number of returned variables
                    387:  */
1.4       misho     388: inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);
1.1       misho     389: 
                    390: 
1.2       misho     391: /*
1.6     ! misho     392:  * rpc_srv_blobCreate() - Create map blob to memory region and return object
        !           393:  *
1.2       misho     394:  * @srv = RPC Server instance
                    395:  * @len = BLOB length object
                    396:  * return: NULL error or !=NULL allocated BLOB object
                    397:  */
                    398: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
                    399: /*
1.6     ! misho     400:  * rpc_srv_blobMap() - Map blob to memory region 
        !           401:  *
1.2       misho     402:  * @srv = RPC Server instance
                    403:  * @blob = Map to this BLOB element
                    404:  * return: -1 error or 0 ok
                    405:  */
                    406: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    407: /*
1.6     ! misho     408:  * rpc_srv_blobUnmap() - Unmap blob memory region 
        !           409:  *
1.2       misho     410:  * @blob = Mapped BLOB element
                    411:  * return: none
                    412:  */
                    413: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
                    414: /*
1.6     ! misho     415:  * rpc_srv_blobFree() - Free blob from disk & memory
        !           416:  *
1.2       misho     417:  * @srv = RPC Server instance
                    418:  * @blob = Mapped BLOB element
                    419:  * return: -1 error or 0 ok
                    420:  */
                    421: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    422: 
                    423: /*
1.6     ! misho     424:  * rpc_srv_registerBLOB() - Register new BLOB to server
        !           425:  *
1.2       misho     426:  * @srv = RPC Server instance
                    427:  * @len = BLOB length
                    428:  * return: NULL error or new registered BLOB
                    429:  */
                    430: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
                    431: /*
1.6     ! misho     432:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
        !           433:  *
1.2       misho     434:  * @srv = RPC Server instance
                    435:  * @var = BLOB Variable for unregister
                    436:  * return: -1 error, 0 not found call, 1 unregister ok
                    437:  */
                    438: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    439: /*
1.6     ! misho     440:  * rpc_srv_getBLOB() - Get registered BLOB 
        !           441:  *
1.2       misho     442:  * @srv = RPC Server instance
                    443:  * @var = hash for variable
                    444:  * return: NULL not found, !=NULL return blob var
                    445:  */
                    446: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    447: 
                    448: /*
1.6     ! misho     449:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
        !           450:  *
1.2       misho     451:  * @cli = Client instance
                    452:  * @blob = Mapped BLOB element
                    453:  * return: -1 error, 0 ok
                    454:  */
                    455: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    456: /*
1.6     ! misho     457:  * rpc_srv_recvBLOB() - Receive BLOB from client
        !           458:  *
1.2       misho     459:  * @cli = Client instance
                    460:  * @blob = Mapped BLOB element
                    461:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
                    462:  */
                    463: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    464: 
1.4       misho     465: /* CLIENT part of functions */
                    466: 
1.2       misho     467: /*
1.6     ! misho     468:  * rpc_cli_sendBLOB() - Send BLOB to server
        !           469:  *
1.2       misho     470:  * @cli = Client instance
                    471:  * @var = BLOB variable
                    472:  * @data = BLOB data
                    473:  * return: -1 error, 0 ok, 1 remote error
                    474:  */
1.4       misho     475: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
1.2       misho     476: /*
1.6     ! misho     477:  * rpc_cli_recvBLOB() - Receive BLOB from server
        !           478:  *
1.2       misho     479:  * @cli = Client instance
                    480:  * @var = BLOB variable
                    481:  * @data = BLOB data, must be free after use!
                    482:  * return: -1 error, 0 ok, 1 remote error
                    483:  */
1.4       misho     484: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     485: /*
1.6     ! misho     486:  * rpc_cli_delBLOB() - Delete BLOB from server
        !           487:  *
1.2       misho     488:  * @cli = Client instance
                    489:  * @var = BLOB variable
                    490:  * return: -1 error, 0 ok, 1 remote error
                    491:  */
1.4       misho     492: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2       misho     493: /*
1.6     ! misho     494:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
        !           495:  *
1.2       misho     496:  * @cli = Client instance
                    497:  * @var = BLOB variable
                    498:  * @data = BLOB data, must be free after use!
                    499:  * return: -1 error, 0 ok, >0 remote error
                    500:  */
1.6     ! misho     501: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
        !           502:                void ** __restrict data);
1.2       misho     503: 
                    504: 
1.6     ! misho     505: /*
        !           506:  * rpc_calcHashes() - Calculate hashes for RPC call
        !           507:  *
        !           508:  * @func = function
        !           509:  * @csModule = Module name, if NULL self binary
        !           510:  * @csFunc = Function name
        !           511:  * return: -1 error or 0 ok
        !           512:  */
        !           513: int rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc);
        !           514: 
1.2       misho     515: 
1.1       misho     516: /* RPC Client side functions */
                    517: 
                    518: /*
1.6     ! misho     519:  * rpc_cli_openClient() - Connect to RPC Server
        !           520:  *
1.1       misho     521:  * @ProgID = ProgramID for RPC session request
                    522:  * @ProcID = ProcessID for RPC session request
1.4       misho     523:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.6     ! misho     524:  * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
1.1       misho     525:  * @family = Family socket type, AF_INET or AF_INET6
                    526:  * @csHost = Host name or IP address for bind server
                    527:  * @Port = Port for bind server, if Port == 0 default port is selected
                    528:  * return: NULL == error or !=NULL connection to RPC server established
                    529:  */
1.6     ! misho     530: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf, 
        !           531:                unsigned char Timeout, unsigned short family, 
        !           532:                const char *csHost, unsigned short Port);
1.1       misho     533: /*
1.6     ! misho     534:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
        !           535:  *
1.1       misho     536:  * @cli = RPC Client session
                    537:  * return: none
                    538:  */
                    539: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
                    540: /*
1.6     ! misho     541:  * rpc_cli_execCall() - Execute RPC call
        !           542:  *
1.1       misho     543:  * @cli = RPC Client session
                    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.4       misho     550: int rpc_cli_execCall(rpc_cli_t *cli, const char *csModule, const char *csFunc, 
                    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>