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

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

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