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

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