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

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

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