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

1.1       misho       1: /*************************************************************************
                      2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.7.2.1 ! misho       6: * $Id: aitrpc.h,v 1.7 2012/03/29 01:34:16 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.1       misho     216: 
1.2       misho     217:                pthread_mutex_t mtx;
1.6       misho     218:        }                       srv_blob;
1.1       misho     219: } rpc_srv_t;
                    220: 
                    221: 
1.2       misho     222: /* 
1.6       misho     223:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
                    224:  *
1.2       misho     225:  * @arg1 = current execution RPC call function
                    226:  * @arg2 = number of items in input array from call request
                    227:  * @arg3 = input array with values from RPC call execution request
                    228:  * return: -1 error or >-1 success execution
                    229:  */
1.4       misho     230: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
1.1       misho     231: 
                    232: 
                    233: // -----------------------------------------------------------------------
                    234: 
                    235: /* Error support functions */
                    236: 
1.3       misho     237: // rpc_GetErrno() Get error code of last operation
                    238: inline int rpc_GetErrno();
                    239: // rpc_GetError() Get error text of last operation
                    240: inline const char *rpc_GetError();
1.1       misho     241: 
                    242: 
1.5       misho     243: /*
1.6       misho     244:  * rpc_chkPktSession() - Check session in RPC packet
                    245:  *
1.5       misho     246:  * @p = packet session
                    247:  * @s = active session
                    248:  * return: -1 error or 0 ok
                    249:  */
                    250: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    251: /*
1.6       misho     252:  * rpc_addPktSession() - Add session into RPC packet
                    253:  *
1.5       misho     254:  * @p = packet session
                    255:  * @s = active session
                    256:  * return: -1 error or 0 ok
                    257:  */
                    258: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    259: 
                    260: 
1.1       misho     261: /* RPC Server side functions */
                    262: 
                    263: /*
1.6       misho     264:  * rpc_srv_initServer() - Init & create RPC Server
                    265:  *
1.1       misho     266:  * @regProgID = ProgramID for authentication & recognition
                    267:  * @regProcID = ProcessID for authentication & recognition
                    268:  * @concurentClients = Concurent clients at same time to this server
1.4       misho     269:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     270:  * @family = Family type, AF_INET, AF_INET6 or AF_LOCAL
                    271:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     272:  * @Port = Port for bind server, if Port == 0 default port is selected
                    273:  * return: NULL == error or !=NULL bind and created RPC server instance
                    274:  */
                    275: rpc_srv_t *rpc_srv_initServer(u_int regProgID, u_int regProcID, int concurentClients, 
1.4       misho     276:                int netBuf, u_short family, const char *csHost, u_short Port);
1.1       misho     277: /*
1.6       misho     278:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
                    279:  *
1.5       misho     280:  * @psrv = RPC Server instance
1.1       misho     281:  * return: none
                    282:  */
1.5       misho     283: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1       misho     284: /*
1.6       misho     285:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
                    286:  *
1.1       misho     287:  * @srv = RPC Server instance
                    288:  * return: -1 error or 0 ok, infinite loop ...
                    289:  */
1.4       misho     290: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
                    291: #define rpc_srv_execServer(_srv, _sync)        do { assert((_srv)); pthread_t __tid; \
                    292:                                                pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    293:                                                                rpc_srv_loopServer, (_srv)); \
                    294:                                                if ((_sync)) \
                    295:                                                        pthread_join(__tid, (void**) (_sync)); \
                    296:                                                else \
                    297:                                                        pthread_detach(__tid); \
                    298:                                        } while (0)
1.1       misho     299: 
                    300: /*
1.6       misho     301:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
                    302:  *
1.3       misho     303:  * @srv = RPC server instance
1.2       misho     304:  * @Port = Port for bind server, if Port == 0 default port is selected
                    305:  * @diskDir = Disk place for BLOB file objects
                    306:  * return: -1 == error or 0 bind and created BLOB server instance
                    307:  */
                    308: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
                    309: /*
1.6       misho     310:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
                    311:  *
1.2       misho     312:  * @srv = RPC Server instance
                    313:  * return: none
                    314:  */
                    315: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
                    316: /*
1.6       misho     317:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
                    318:  *
1.2       misho     319:  * @srv = RPC Server instance
                    320:  * return: -1 error or 0 ok, infinite loop ...
                    321:  */
1.4       misho     322: int rpc_srv_loopBLOB(rpc_srv_t * __restrict srv);
                    323: #define rpc_srv_execBLOBServer(_srv)   do { assert((_srv)); pthread_t __tid; \
                    324:                                                if ((_srv)->srv_blob.state == enable) { \
                    325:                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    326:                                                                        rpc_srv_loopBLOB, (_srv)); \
                    327:                                                        pthread_detach(__tid); \
                    328:                                                        (_srv)->srv_blob.state = running; \
                    329:                                                } \
                    330:                                        } while (0)
1.2       misho     331: 
                    332: /*
1.6       misho     333:  * rpc_srv_registerCall() - Register call to RPC server
                    334:  *
1.1       misho     335:  * @srv = RPC Server instance
                    336:  * @csModule = Module name, if NULL self binary
                    337:  * @csFunc = Function name
1.2       misho     338:  * @args = Number of return function arguments, use for restriction case!
1.1       misho     339:  * return: -1 error or 0 register ok
                    340:  */
                    341: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc, 
1.4       misho     342:                unsigned short args);
1.1       misho     343: /*
1.6       misho     344:  * rpc_srv_unregisterCall() - Unregister call from RPC server
                    345:  *
1.1       misho     346:  * @srv = RPC Server instance
                    347:  * @csModule = Module name, if NULL self binary
                    348:  * @csFunc = Function name
                    349:  * return: -1 error, 0 not found call, 1 unregister ok
                    350:  */
                    351: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    352: /*
1.6       misho     353:  * rpc_srv_getFunc() - Get registered call from RPC server by Name
                    354:  *
1.1       misho     355:  * @srv = RPC Server instance
                    356:  * @csModule = Module name, if NULL self binary
                    357:  * @csFunc = Function name
                    358:  * return: NULL not found call, !=NULL return call
                    359:  */
                    360: rpc_func_t *rpc_srv_getFunc(rpc_srv_t * __restrict srv, const char *csModule, const char *csFunc);
                    361: /*
1.6       misho     362:  * rpc_srv_getCall() - Get registered call from RPC server
                    363:  *
1.1       misho     364:  * @srv = RPC Server instance
                    365:  * @tag = tag for function
                    366:  * @hash = hash for function
                    367:  * return: NULL not found call, !=NULL return call
                    368:  */
                    369: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag, uint32_t hash);
                    370: /*
1.6       misho     371:  * rpc_srv_execCall() - Execute registered call from RPC server
                    372:  *
1.1       misho     373:  * @call = Register RPC call
                    374:  * @rpc = IN RPC call structure
1.4       misho     375:  * @args = IN RPC calling arguments from RPC client
1.1       misho     376:  * return: -1 error, !=-1 ok
                    377:  */
1.2       misho     378: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, 
1.4       misho     379:                array_t * __restrict args);
1.1       misho     380: 
                    381: 
                    382: /*
1.6       misho     383:  * rpc_srv_getVars() - Get variables array for RPC call
                    384:  *
1.1       misho     385:  * @call = RPC function call
1.3       misho     386:  * @vars = Returned variables array, may be NULL
1.1       misho     387:  * return: -1 error, !=-1 Number of returned variables
                    388:  */
1.4       misho     389: inline int rpc_srv_getVars(rpc_func_t * __restrict call, array_t ** __restrict vars);
1.1       misho     390: 
                    391: 
1.2       misho     392: /*
1.6       misho     393:  * rpc_srv_blobCreate() - Create map blob to memory region and return object
                    394:  *
1.2       misho     395:  * @srv = RPC Server instance
                    396:  * @len = BLOB length object
                    397:  * return: NULL error or !=NULL allocated BLOB object
                    398:  */
                    399: inline rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len);
                    400: /*
1.6       misho     401:  * rpc_srv_blobMap() - Map blob to memory region 
                    402:  *
1.2       misho     403:  * @srv = RPC Server instance
                    404:  * @blob = Map to this BLOB element
                    405:  * return: -1 error or 0 ok
                    406:  */
                    407: inline int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    408: /*
1.6       misho     409:  * rpc_srv_blobUnmap() - Unmap blob memory region 
                    410:  *
1.2       misho     411:  * @blob = Mapped BLOB element
                    412:  * return: none
                    413:  */
                    414: inline void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
                    415: /*
1.6       misho     416:  * rpc_srv_blobFree() - Free blob from disk & memory
                    417:  *
1.2       misho     418:  * @srv = RPC Server instance
                    419:  * @blob = Mapped BLOB element
                    420:  * return: -1 error or 0 ok
                    421:  */
                    422: inline int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
                    423: 
                    424: /*
1.6       misho     425:  * rpc_srv_registerBLOB() - Register new BLOB to server
                    426:  *
1.2       misho     427:  * @srv = RPC Server instance
                    428:  * @len = BLOB length
                    429:  * return: NULL error or new registered BLOB
                    430:  */
                    431: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len);
                    432: /*
1.6       misho     433:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
                    434:  *
1.2       misho     435:  * @srv = RPC Server instance
                    436:  * @var = BLOB Variable for unregister
                    437:  * return: -1 error, 0 not found call, 1 unregister ok
                    438:  */
                    439: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    440: /*
1.6       misho     441:  * rpc_srv_getBLOB() - Get registered BLOB 
                    442:  *
1.2       misho     443:  * @srv = RPC Server instance
                    444:  * @var = hash for variable
                    445:  * return: NULL not found, !=NULL return blob var
                    446:  */
                    447: inline rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    448: 
                    449: /*
1.6       misho     450:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
                    451:  *
1.2       misho     452:  * @cli = Client instance
                    453:  * @blob = Mapped BLOB element
                    454:  * return: -1 error, 0 ok
                    455:  */
                    456: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    457: /*
1.6       misho     458:  * rpc_srv_recvBLOB() - Receive BLOB from client
                    459:  *
1.2       misho     460:  * @cli = Client instance
                    461:  * @blob = Mapped BLOB element
                    462:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
                    463:  */
                    464: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    465: 
1.4       misho     466: /* CLIENT part of functions */
                    467: 
1.2       misho     468: /*
1.6       misho     469:  * rpc_cli_sendBLOB() - Send BLOB to server
                    470:  *
1.2       misho     471:  * @cli = Client instance
                    472:  * @var = BLOB variable
                    473:  * @data = BLOB data
                    474:  * return: -1 error, 0 ok, 1 remote error
                    475:  */
1.4       misho     476: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void * __restrict data);
1.2       misho     477: /*
1.6       misho     478:  * rpc_cli_recvBLOB() - Receive BLOB from server
                    479:  *
1.2       misho     480:  * @cli = Client instance
                    481:  * @var = BLOB variable
                    482:  * @data = BLOB data, must be free after use!
                    483:  * return: -1 error, 0 ok, 1 remote error
                    484:  */
1.4       misho     485: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     486: /*
1.6       misho     487:  * rpc_cli_delBLOB() - Delete BLOB from server
                    488:  *
1.2       misho     489:  * @cli = Client instance
                    490:  * @var = BLOB variable
                    491:  * return: -1 error, 0 ok, 1 remote error
                    492:  */
1.4       misho     493: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2       misho     494: /*
1.6       misho     495:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
                    496:  *
1.2       misho     497:  * @cli = Client instance
                    498:  * @var = BLOB variable
                    499:  * @data = BLOB data, must be free after use!
                    500:  * return: -1 error, 0 ok, >0 remote error
                    501:  */
1.6       misho     502: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
                    503:                void ** __restrict data);
1.2       misho     504: 
                    505: 
1.6       misho     506: /*
                    507:  * rpc_calcHashes() - Calculate hashes for RPC call
                    508:  *
                    509:  * @func = function
                    510:  * @csModule = Module name, if NULL self binary
                    511:  * @csFunc = Function name
                    512:  * return: -1 error or 0 ok
                    513:  */
                    514: int rpc_calcHashes(rpc_func_t * __restrict func, const char *csModule, const char *csFunc);
                    515: 
1.2       misho     516: 
1.1       misho     517: /* RPC Client side functions */
                    518: 
                    519: /*
1.6       misho     520:  * rpc_cli_openClient() - Connect to RPC Server
                    521:  *
1.1       misho     522:  * @ProgID = ProgramID for RPC session request
                    523:  * @ProcID = ProcessID for RPC session request
1.4       misho     524:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.6       misho     525:  * @Timeout = RPC timeout in seconds, if =0 set default RPC timeout
1.1       misho     526:  * @family = Family socket type, AF_INET or AF_INET6
                    527:  * @csHost = Host name or IP address for bind server
                    528:  * @Port = Port for bind server, if Port == 0 default port is selected
                    529:  * return: NULL == error or !=NULL connection to RPC server established
                    530:  */
1.6       misho     531: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned int ProcID, int netBuf, 
                    532:                unsigned char Timeout, unsigned short family, 
                    533:                const char *csHost, unsigned short Port);
1.1       misho     534: /*
1.6       misho     535:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
                    536:  *
1.1       misho     537:  * @cli = RPC Client session
                    538:  * return: none
                    539:  */
                    540: void rpc_cli_closeClient(rpc_cli_t * __restrict cli);
                    541: /*
1.6       misho     542:  * rpc_cli_execCall() - Execute RPC call
                    543:  *
1.1       misho     544:  * @cli = RPC Client session
1.7       misho     545:  * @noreply = We not want RPC reply
1.1       misho     546:  * @csModule = Module name, if NULL self binary
                    547:  * @csFunc = Function name for execute
1.3       misho     548:  * @in_vars = IN RPC call array of rpc values
1.4       misho     549:  * @out_vars = OUT returned array of rpc values, must be free after use with rpc_cli_freeVals()
1.1       misho     550:  * return: -1 error or != -1 ok result
                    551:  */
1.7       misho     552: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, const char *csModule, const char *csFunc, 
1.4       misho     553:                array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.1       misho     554: 
                    555: 
1.2       misho     556: /*
1.6       misho     557:  * rpc_cli_openBLOBClient() - Connect to BLOB Server
                    558:  *
1.2       misho     559:  * @rpccli = RPC Client session
                    560:  * @Port = Port for bind server, if Port == 0 default port is selected
                    561:  * return: NULL == error or !=NULL connection to BLOB server established
                    562:  */
                    563: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, u_short Port);
                    564: /*
1.6       misho     565:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
                    566:  *
1.2       misho     567:  * @cli = BLOB Client session
                    568:  * return: none
                    569:  */
                    570: void rpc_cli_closeBLOBClient(rpc_cli_t * __restrict cli);
                    571: 
                    572: 
1.1       misho     573: #endif

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