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

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

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