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

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

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