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

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.13! misho       6: * $Id: aitrpc.h,v 1.8.2.12 2012/05/16 13:32:47 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.8.2.5   misho      75: #define CALL_MAX_ID            65535
                     76: 
1.2       misho      77: #define CALL_BLOBSHUTDOWN      "rpcBLOBServerShutdown"
1.8.2.5   misho      78: #define CALL_BLOBSHUTDOWN_ID   65530
1.2       misho      79: #define CALL_BLOBCLIENTS       "rpcBLOBServerClients"
1.8.2.5   misho      80: #define CALL_BLOBCLIENTS_ID    65529
1.2       misho      81: #define CALL_BLOBVARS          "rpcBLOBServerVars"
1.8.2.5   misho      82: #define CALL_BLOBVARS_ID       65528
1.2       misho      83: 
                     84: #define CALL_SRVSHUTDOWN       "rpcServerShutdown"
1.8.2.5   misho      85: #define CALL_SRVSHUTDOWN_ID    65534
1.1       misho      86: #define CALL_SRVCLIENTS                "rpcServerClients"
1.8.2.5   misho      87: #define CALL_SRVCLIENTS_ID     65533
1.1       misho      88: #define CALL_SRVCALLS          "rpcServerCalls"
1.8.2.5   misho      89: #define CALL_SRVCALLS_ID       65532
1.1       misho      90: #define CALL_SRVSESSIONS       "rpcServerSessions"
1.8.2.5   misho      91: #define CALL_SRVSESSIONS_ID    65531
1.1       misho      92: 
                     93: 
                     94: /* RPC types */
                     95: 
                     96: typedef enum {
1.6       misho      97:        ok, error, no,                          /* for blob reply */
1.4       misho      98:        get, set, unset                         /* for blob request */
1.2       misho      99: } cmd_type_t;
                    100: 
1.1       misho     101: 
1.4       misho     102: #define RPC_CALLBACK_CHECK_INPUT(_f)   do { \
                    103:                                                assert((_f)); \
                    104:                                                if (!(_f)) { \
1.6       misho     105:                                                        rpc_SetErr(EINVAL, \
                    106:                                                                        "Invalid callback parameters ..."); \
1.2       misho     107:                                                        return -1; \
                    108:                                                } \
                    109:                                        } while (0)
1.4       misho     110: #define RPC_CALLBACK_CHK_ARGS(_f, _n)  do { \
                    111:                                                RPC_CALLBACK_CHECK_INPUT((_f)); \
1.5       misho     112:                                                if ((_f) && io_arraySize((_f)->func_vars) < _n) { \
1.6       misho     113:                                                        rpc_SetErr(EINVAL, \
                    114:                                                                        "Not enough number of arguments!"); \
1.1       misho     115:                                                        return -1; \
                    116:                                                } \
1.2       misho     117:                                        } while (0)
1.1       misho     118: 
                    119: 
                    120: /* RPC session identification */
                    121: 
                    122: typedef struct {
                    123:        uint8_t         sess_version;
                    124:        uint32_t        sess_program;
1.8.2.2   misho     125:        uint8_t         sess_process;
                    126: } __packed rpc_sess_t;         /* size == 6 bytes */
1.1       misho     127: 
                    128: 
                    129: /* Server managment RPC functions ... */
                    130: 
                    131: /* Network RPC packet - Client request */
                    132: 
                    133: struct tagRPCCall {
                    134:        rpc_sess_t      call_session;
1.6       misho     135: 
1.8.2.2   misho     136:        uint16_t        call_seq;
1.7       misho     137:        uint16_t        call_len;
1.8.2.2   misho     138:        uint16_t        call_crc;
1.1       misho     139: 
1.6       misho     140:        union {
                    141:                struct {
                    142:                        uint64_t        flags;
                    143:                }       call_req;
                    144:                struct {
                    145:                        int32_t         ret;
                    146:                        int32_t         eno;
                    147:                }       call_rep;
                    148:        };
1.1       misho     149: 
1.8.2.2   misho     150:        uint16_t        call_tag;
                    151:        uint16_t        call_argc;
                    152:        ait_val_t       call_argv[0];
1.8.2.4   misho     153: } __packed;                    /* size == 24 bytes */
1.1       misho     154: 
1.2       misho     155: /* Network BLOB packet - Header */
                    156: 
                    157: struct tagBLOBHdr {
                    158:        rpc_sess_t      hdr_session;
                    159:        uint8_t         hdr_cmd;
                    160:        uint32_t        hdr_var;
                    161:        uint32_t        hdr_len;
                    162:        uint32_t        hdr_ret;
1.6       misho     163:        uint16_t        hdr_crc;
                    164:        uint8_t         hdr_pad;
1.8.2.13! misho     165: } __packed;                    /* size == 22 bytes */
1.2       misho     166: 
1.1       misho     167: /* Network RPC client & server elements */
                    168: 
1.8.2.2   misho     169: /* RPC function registration element! */
                    170: typedef struct tagRPCFunc {
                    171:        ait_val_t               func_name;
                    172: 
                    173:        array_t                 *func_vars;
                    174: 
                    175:        void                    *func_parent;
                    176:        TAILQ_ENTRY(tagRPCFunc) func_node;
                    177: } rpc_func_t;
                    178: 
                    179: 
1.8.2.8   misho     180: /* BLOB register element */
                    181: typedef struct tagBLOB {
                    182:        uint32_t                blob_var;       /* BLOB id */
                    183: 
                    184:        size_t                  blob_len;       /* size of allocated BLOB data */
                    185:        void                    *blob_data;     /* mapped BLOB data */
                    186: 
                    187:        TAILQ_ENTRY(tagBLOB)    blob_node;
                    188: } rpc_blob_t;
                    189: 
                    190: 
1.1       misho     191: typedef struct {
1.8.2.1   misho     192:        int             cli_id;         /* slot id */
                    193:        int             cli_sock;       /* socket fd */
                    194:        io_sockaddr_t   cli_sa;         /* host address */
                    195:        ait_val_t       cli_buf;        /* network buffer */
1.8       misho     196: 
1.8.2.1   misho     197:        void            *cli_parent;    /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
1.1       misho     198: } rpc_cli_t;
                    199: 
                    200: typedef struct {
1.8.2.1   misho     201:        rpc_sess_t                      srv_session;    /* RPC session registration info */
                    202:        int                             srv_netbuf;     /* size of network buffer */
1.1       misho     203: 
1.8.2.1   misho     204:        sched_root_task_t               *srv_root;      /* RPC server scheduler */
                    205:        intptr_t                        srv_kill;       /* Scheduler condition variable */
1.2       misho     206: 
1.8.2.1   misho     207:        rpc_cli_t                       srv_server;     /* RPC server socket */
                    208:        array_t                         *srv_clients;   /* connected rpc client sockets */
1.2       misho     209: 
1.8.2.1   misho     210:        TAILQ_HEAD(, tagRPCFunc)        srv_funcs;      /* RPC functions list */
1.2       misho     211: 
                    212:        struct {
1.8.2.10  misho     213:                sched_root_task_t               *root;          /* BLOB server scheduler */
                    214:                intptr_t                        kill;           /* BLOB server state: ==0 disable | !=0 enable */
                    215: 
1.8.2.8   misho     216:                ait_val_t                       dir;            /* BLOB states directory */
1.2       misho     217: 
1.8.2.8   misho     218:                rpc_cli_t                       server;         /* BLOB server socket */
                    219:                array_t                         *clients;       /* connected blob client sockets */
1.1       misho     220: 
1.8.2.8   misho     221:                TAILQ_HEAD(, tagBLOB)           blobs;          /* registered blob variables list */
1.8.2.1   misho     222:        }                               srv_blob;
1.1       misho     223: } rpc_srv_t;
                    224: 
                    225: 
1.2       misho     226: /* 
1.6       misho     227:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
                    228:  *
1.2       misho     229:  * @arg1 = current execution RPC call function
                    230:  * @arg2 = number of items in input array from call request
                    231:  * @arg3 = input array with values from RPC call execution request
                    232:  * return: -1 error or >-1 success execution
                    233:  */
1.4       misho     234: typedef int (*rpc_callback_t)(rpc_func_t *, int, array_t *);
1.1       misho     235: 
                    236: 
                    237: // -----------------------------------------------------------------------
                    238: 
                    239: /* Error support functions */
                    240: 
1.3       misho     241: // rpc_GetErrno() Get error code of last operation
                    242: inline int rpc_GetErrno();
                    243: // rpc_GetError() Get error text of last operation
                    244: inline const char *rpc_GetError();
1.1       misho     245: 
                    246: 
1.5       misho     247: /*
1.8.2.1   misho     248:  * rpc_chkPktSession() - Check RPC session
1.6       misho     249:  *
1.5       misho     250:  * @p = packet session
                    251:  * @s = active session
1.8.2.1   misho     252:  * return: -1, 1, 2, 3 are errors or 0 ok
1.5       misho     253:  */
                    254: inline int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
                    255: /*
1.8.2.1   misho     256:  * rpc_addPktSession() - Prepare session into network format
1.6       misho     257:  *
1.5       misho     258:  * @p = packet session
1.8.2.1   misho     259:  * @s = host session
1.5       misho     260:  * return: -1 error or 0 ok
                    261:  */
                    262: inline int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
1.8.2.1   misho     263: /*
                    264:  * rpc_register_srvServices() - Register internal service functions
                    265:  *
                    266:  * @srv = RPC server instance
                    267:  * return: -1 error or 0 ok
                    268:  */
                    269: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
1.8.2.6   misho     270: /*
                    271:  * rpc_register_blobServices() - Register internal service functions
                    272:  *
                    273:  * @srv = RPC server instance
                    274:  * return: -1 error or 0 ok
                    275:  */
                    276: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
1.5       misho     277: 
                    278: 
1.1       misho     279: /* RPC Server side functions */
                    280: 
                    281: /*
1.6       misho     282:  * rpc_srv_initServer() - Init & create RPC Server
                    283:  *
1.1       misho     284:  * @regProgID = ProgramID for authentication & recognition
                    285:  * @regProcID = ProcessID for authentication & recognition
                    286:  * @concurentClients = Concurent clients at same time to this server
1.4       misho     287:  * @netBuf = Network buffer length, if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     288:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     289:  * @Port = Port for bind server, if Port == 0 default port is selected
                    290:  * return: NULL == error or !=NULL bind and created RPC server instance
                    291:  */
1.8.2.2   misho     292: rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID, 
                    293:                int concurentClients, int netBuf, 
                    294:                const char *csHost, unsigned short Port);
1.1       misho     295: /*
1.6       misho     296:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
                    297:  *
1.5       misho     298:  * @psrv = RPC Server instance
1.1       misho     299:  * return: none
                    300:  */
1.5       misho     301: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1       misho     302: /*
1.6       misho     303:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
                    304:  *
1.1       misho     305:  * @srv = RPC Server instance
                    306:  * return: -1 error or 0 ok, infinite loop ...
                    307:  */
1.4       misho     308: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
                    309: #define rpc_srv_execServer(_srv, _sync)        do { assert((_srv)); pthread_t __tid; \
1.8.2.10  misho     310:                                                if (!(_srv)->srv_kill) { \
                    311:                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \
                    312:                                                                        rpc_srv_loopServer, (_srv)); \
                    313:                                                        if ((_sync)) \
                    314:                                                                pthread_join(__tid, (void**) (_sync)); \
                    315:                                                        else \
                    316:                                                                pthread_detach(__tid); \
                    317:                                                } } while (0)
1.1       misho     318: 
                    319: /*
1.6       misho     320:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
                    321:  *
1.3       misho     322:  * @srv = RPC server instance
1.2       misho     323:  * @Port = Port for bind server, if Port == 0 default port is selected
                    324:  * @diskDir = Disk place for BLOB file objects
                    325:  * return: -1 == error or 0 bind and created BLOB server instance
                    326:  */
                    327: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, u_short Port, const char *diskDir);
                    328: /*
1.6       misho     329:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
                    330:  *
1.2       misho     331:  * @srv = RPC Server instance
                    332:  * return: none
                    333:  */
                    334: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
                    335: /*
1.6       misho     336:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
                    337:  *
1.2       misho     338:  * @srv = RPC Server instance
                    339:  * return: -1 error or 0 ok, infinite loop ...
                    340:  */
1.8.2.10  misho     341: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
1.4       misho     342: #define rpc_srv_execBLOBServer(_srv)   do { assert((_srv)); pthread_t __tid; \
1.8.2.10  misho     343:                                                if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
1.4       misho     344:                                                        pthread_create(&__tid, NULL, (void*(*)(void*)) \
1.8.2.10  misho     345:                                                                        rpc_srv_loopBLOBServer, (_srv)); \
1.4       misho     346:                                                        pthread_detach(__tid); \
                    347:                                                } \
                    348:                                        } while (0)
1.2       misho     349: 
                    350: /*
1.6       misho     351:  * rpc_srv_registerCall() - Register call to RPC server
                    352:  *
1.1       misho     353:  * @srv = RPC Server instance
1.8.2.4   misho     354:  * @tag = Function tag
                    355:  * @funcaddr = Function address
                    356:  * @args = Number of return function arguments
                    357:  * return: -1 error, 0 already registered tag or 1 register ok
1.1       misho     358:  */
1.8.2.4   misho     359: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, 
                    360:                void *funcaddr, unsigned short args);
1.1       misho     361: /*
1.6       misho     362:  * rpc_srv_unregisterCall() - Unregister call from RPC server
                    363:  *
1.1       misho     364:  * @srv = RPC Server instance
1.8.2.4   misho     365:  * @tag = Function tag
1.1       misho     366:  * return: -1 error, 0 not found call, 1 unregister ok
                    367:  */
1.8.2.4   misho     368: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
1.1       misho     369: /*
1.8.2.4   misho     370:  * rpc_srv_getCall()  - Get registered call from RPC server
1.6       misho     371:  *
1.1       misho     372:  * @srv = RPC Server instance
                    373:  * @tag = tag for function
                    374:  * return: NULL not found call, !=NULL return call
                    375:  */
1.8.2.2   misho     376: inline rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
1.1       misho     377: /*
1.6       misho     378:  * rpc_srv_execCall() - Execute registered call from RPC server
                    379:  *
1.1       misho     380:  * @call = Register RPC call
                    381:  * @rpc = IN RPC call structure
1.4       misho     382:  * @args = IN RPC calling arguments from RPC client
1.1       misho     383:  * return: -1 error, !=-1 ok
                    384:  */
1.2       misho     385: int rpc_srv_execCall(rpc_func_t * __restrict call, struct tagRPCCall * __restrict rpc, 
1.4       misho     386:                array_t * __restrict args);
1.1       misho     387: 
                    388: 
                    389: /*
1.8.2.9   misho     390:  * rpc_srv_blobCreate() - Create and map blob to memory region and return object
1.6       misho     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.6       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.6       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.6       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.6       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.6       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.6       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.6       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.6       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.6       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.6       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.6       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.6       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.6       misho     499: inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
                    500:                void ** __restrict data);
1.2       misho     501: 
                    502: 
1.1       misho     503: /* RPC Client side functions */
                    504: 
                    505: /*
1.6       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.8.2.11  misho     516: rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf, 
                    517:                unsigned short family, const char *csHost, unsigned short Port);
1.1       misho     518: /*
1.6       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:  */
1.8.2.11  misho     524: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
1.1       misho     525: /*
1.6       misho     526:  * rpc_cli_execCall() - Execute RPC call
                    527:  *
1.1       misho     528:  * @cli = RPC Client session
1.7       misho     529:  * @noreply = We not want RPC reply
1.8.2.11  misho     530:  * @tag = Function tag for execution
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.8.2.11  misho     535: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, u_short tag, 
1.4       misho     536:                array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.1       misho     537: 
                    538: 
1.2       misho     539: /*
1.6       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.6       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:  */
1.8.2.11  misho     553: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
1.2       misho     554: 
                    555: 
1.1       misho     556: #endif

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