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

1.1       misho       1: /*************************************************************************
                      2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.20.8.1! misho       6: * $Id: aitrpc.h,v 1.20 2013/09/05 00:43:04 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.13      misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
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.9       misho      60: #include <sys/queue.h>
1.13      misho      61: #include <elwix.h>
1.6       misho      62: #include <aitsched.h>
1.1       misho      63: 
                     64: 
1.18      misho      65: #define RPC_VERSION            7
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.9       misho      75: #define CALL_TAG_MAX           65535
                     76: 
                     77: #define CALL_SRVPING           65534
                     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: 
1.16      misho      88: /* RPC signals */
                     89: #define SIGFBLOB               54
1.1       misho      90: 
                     91: /* RPC types */
                     92: 
                     93: typedef enum {
1.6       misho      94:        ok, error, no,                          /* for blob reply */
1.4       misho      95:        get, set, unset                         /* for blob request */
1.14      misho      96: } blob_cmd_type_t;
1.2       misho      97: 
1.1       misho      98: 
1.9       misho      99: #define RPC_CALLBACK_CHECK_INPUT(x)    do { \
                    100:                                                assert((x)); \
                    101:                                                if (!(x)) { \
1.6       misho     102:                                                        rpc_SetErr(EINVAL, \
                    103:                                                                        "Invalid callback parameters ..."); \
1.2       misho     104:                                                        return -1; \
                    105:                                                } \
                    106:                                        } while (0)
1.1       misho     107: 
                    108: 
                    109: /* RPC session identification */
                    110: 
                    111: typedef struct {
1.14      misho     112: #if BYTE_ORDER == LITTLE_ENDIAN
                    113:        uint16_t        sess_instance:8;
                    114:        uint16_t        sess_version:8;
                    115: #endif
                    116: #if BYTE_ORDER == BIG_ENDIAN
                    117:        uint16_t        sess_version:8;
                    118:        uint16_t        sess_instance:8;
                    119: #endif
                    120: } __packed rpc_sess_t; /* size == 2 bytes */
1.1       misho     121: 
                    122: 
                    123: /* Server managment RPC functions ... */
                    124: 
                    125: /* Network RPC packet - Client request */
                    126: 
                    127: struct tagRPCCall {
                    128:        rpc_sess_t      call_session;
1.6       misho     129: 
1.18      misho     130:        uint32_t        call_len;
1.9       misho     131:        uint16_t        call_crc;
1.1       misho     132: 
1.6       misho     133:        union {
                    134:                struct {
                    135:                        uint64_t        flags;
                    136:                }       call_req;
                    137:                struct {
                    138:                        int32_t         ret;
                    139:                        int32_t         eno;
                    140:                }       call_rep;
                    141:        };
1.1       misho     142: 
1.9       misho     143:        uint16_t        call_tag;
                    144:        uint16_t        call_argc;
                    145:        ait_val_t       call_argv[0];
1.14      misho     146: } __packed;                    /* size == 20 bytes */
1.20      misho     147: #define RPC_CHK_NOREPLY(x)     (ntohl((u_long) (x)->call_req.flags) & RPC_NOREPLY)
                    148: #define RPC_SET_ERRNO(x, _v)   ((x)->call_rep.eno = htonl((_v)))
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:        uint8_t         hdr_pad;
1.14      misho     159: } __packed;                    /* size == 16 bytes */
1.2       misho     160: 
1.1       misho     161: /* Network RPC client & server elements */
                    162: 
1.9       misho     163: /* RPC function registration element! */
                    164: typedef struct tagRPCFunc {
                    165:        ait_val_t               func_name;
1.1       misho     166: 
1.9       misho     167:        void                    *func_parent;
1.11      misho     168: 
                    169:        SLIST_ENTRY(tagRPCFunc) func_next;
                    170:        AVL_ENTRY(tagRPCFunc)   func_node;
1.9       misho     171: } rpc_func_t;
                    172: #define RPC_FUNC_SERVER(x)     ((rpc_srv_t*) (x)->func_parent)
1.8       misho     173: 
1.11      misho     174: /* Tree root node */
                    175: typedef struct tagRPCFuncs {
                    176:        pthread_mutex_t         mtx;
                    177: 
                    178:        struct tagRPCFunc       *slh_first;
                    179:        struct tagRPCFunc       *avlh_root;
                    180: } rpc_funcs_t;
                    181: #define RPC_FUNCS_LOCK(x)      pthread_mutex_lock(&(x)->mtx)
                    182: #define RPC_FUNCS_UNLOCK(x)    pthread_mutex_unlock(&(x)->mtx)
                    183: #define RPC_FUNCS_ISEMPTY(x)   AVL_EMPTY((x))
                    184: 
1.1       misho     185: 
1.9       misho     186: /* BLOB register element */
1.2       misho     187: typedef struct tagBLOB {
1.9       misho     188:        uint32_t                blob_var;       /* BLOB id */
1.2       misho     189: 
1.9       misho     190:        size_t                  blob_len;       /* size of allocated BLOB data */
                    191:        void                    *blob_data;     /* mapped BLOB data */
1.2       misho     192: 
1.9       misho     193:        TAILQ_ENTRY(tagBLOB)    blob_node;
1.2       misho     194: } rpc_blob_t;
                    195: 
1.9       misho     196: 
1.1       misho     197: typedef struct {
1.9       misho     198:        int             cli_id;         /* slot id */
                    199:        int             cli_sock;       /* socket fd */
1.13      misho     200:        sockaddr_t      cli_sa;         /* host address */
1.9       misho     201:        ait_val_t       cli_buf;        /* network buffer */
1.1       misho     202: 
1.9       misho     203:        array_t         *cli_vars;      /* function return variables */
1.2       misho     204: 
1.9       misho     205:        void            *cli_parent;    /* pointer to parent rpc_srv_t for server or to rpc_sess_t for client */
                    206: } rpc_cli_t;
                    207: #define RPC_RETVARS(x)         ((x)->cli_vars)
                    208: #define RPC_SRV_SERVER(x)      ((rpc_srv_t*) (x)->cli_parent)
                    209: #define RPC_CLI_SESSION(x)     ((rpc_sess_t*) (x)->cli_parent)
                    210: 
                    211: typedef struct {
                    212:        rpc_sess_t                      srv_session;    /* RPC session registration info */
                    213:        int                             srv_netbuf;     /* size of network buffer */
1.12      misho     214:        int                             srv_proto;      /* Server protocol */
1.2       misho     215: 
1.9       misho     216:        pthread_t                       srv_tid;        /* RPC exec pthread */
                    217:        sched_root_task_t               *srv_root;      /* RPC server scheduler */
                    218:        intptr_t                        srv_kill;       /* Scheduler condition variable */
                    219: 
                    220:        rpc_cli_t                       srv_server;     /* RPC server socket */
                    221:        array_t                         *srv_clients;   /* connected rpc client sockets */
                    222: 
1.11      misho     223:        rpc_funcs_t                     srv_funcs;      /* RPC functions */
1.2       misho     224: 
                    225:        struct {
1.9       misho     226:                pthread_t                       tid;            /* BLOB exec pthread */
                    227:                sched_root_task_t               *root;          /* BLOB server scheduler */
                    228:                intptr_t                        kill;           /* BLOB server state: ==0 disable | !=0 enable */
1.2       misho     229: 
1.9       misho     230:                ait_val_t                       dir;            /* BLOB states directory */
1.1       misho     231: 
1.9       misho     232:                rpc_cli_t                       server;         /* BLOB server socket */
                    233:                array_t                         *clients;       /* connected blob client sockets */
                    234: 
                    235:                TAILQ_HEAD(, tagBLOB)           blobs;          /* registered blob variables list */
                    236:        }                               srv_blob;
1.1       misho     237: } rpc_srv_t;
                    238: 
                    239: 
1.2       misho     240: /* 
1.6       misho     241:  * (*rpc_callback_t)() - Callback type definition for RPC call in server process
                    242:  *
1.9       misho     243:  * @arg1 = RPC client
                    244:  * @arg2 = RPC packet header
1.2       misho     245:  * @arg3 = input array with values from RPC call execution request
                    246:  * return: -1 error or >-1 success execution
                    247:  */
1.9       misho     248: typedef int (*rpc_callback_t)(rpc_cli_t *, struct tagRPCCall *, array_t *);
1.1       misho     249: 
                    250: 
1.9       misho     251: /* ----------------------------------------------------------------------- */
1.1       misho     252: 
                    253: /* Error support functions */
                    254: 
1.3       misho     255: // rpc_GetErrno() Get error code of last operation
1.15      misho     256: int rpc_GetErrno();
1.3       misho     257: // rpc_GetError() Get error text of last operation
1.15      misho     258: const char *rpc_GetError();
1.17      misho     259: // rpc_SetErr() Set error to variables for internal use!!!
                    260: void rpc_SetErr(int eno, char *estr, ...);
                    261: 
1.1       misho     262: 
                    263: 
1.5       misho     264: /*
1.19      misho     265:  * rpc_Read() - RPC read operation
                    266:  *
                    267:  * @sock = socket
                    268:  * @type = type of socket
                    269:  * @flags = receive flags
                    270:  * @sa = check client address, if you use udp protocol
                    271:  * @buf = buffer
                    272:  * @blen = buffer length
                    273:  * return: -1 error or >-1 readed bytes into buffer
                    274:  */
                    275: ssize_t rpc_Read(int sock, int type, int flags, sockaddr_t * __restrict sa, 
                    276:                unsigned char * __restrict buf, size_t blen);
                    277: /*
                    278:  * rpc_Write() - RPC write operation
                    279:  *
                    280:  * @sock = socket
                    281:  * @type = type of socket
                    282:  * @flags = send flags
                    283:  * @sa = send to client address, if you use udp protocol
                    284:  * @buf = buffer
                    285:  * @blen = buffer length
                    286:  * return: -1 error or >-1 written bytes into buffer
                    287:  */
                    288: ssize_t rpc_Write(int sock, int type, int flags, sockaddr_t * __restrict sa, 
                    289:                unsigned char * __restrict buf, size_t blen);
                    290: 
                    291: /*
1.9       misho     292:  * rpc_chkPktSession() - Check RPC session
1.6       misho     293:  *
1.5       misho     294:  * @p = packet session
                    295:  * @s = active session
1.9       misho     296:  * return: -1, 1, 2, 3 are errors or 0 ok
1.5       misho     297:  */
1.15      misho     298: int rpc_chkPktSession(rpc_sess_t *p, rpc_sess_t *s);
1.5       misho     299: /*
1.9       misho     300:  * rpc_addPktSession() - Prepare session into network format
1.6       misho     301:  *
1.5       misho     302:  * @p = packet session
1.9       misho     303:  * @s = host session
1.5       misho     304:  * return: -1 error or 0 ok
                    305:  */
1.15      misho     306: int rpc_addPktSession(rpc_sess_t *p, rpc_sess_t *s);
1.9       misho     307: /*
                    308:  * rpc_register_srvPing() - Register ping service function
                    309:  *
                    310:  * @srv = RPC server instance
                    311:  * return: -1 error or 0 ok
                    312:  */
1.15      misho     313: int rpc_register_srvPing(rpc_srv_t * __restrict srv);
1.9       misho     314: /*
                    315:  * rpc_register_srvServices() - Register internal service functions
                    316:  *
                    317:  * @srv = RPC server instance
                    318:  * return: -1 error or 0 ok
                    319:  */
                    320: int rpc_register_srvServices(rpc_srv_t * __restrict srv);
                    321: /*
                    322:  * rpc_register_blobServices() - Register internal service functions
                    323:  *
                    324:  * @srv = RPC server instance
                    325:  * return: -1 error or 0 ok
                    326:  */
                    327: int rpc_register_blobServices(rpc_srv_t * __restrict srv);
1.5       misho     328: 
                    329: 
1.1       misho     330: /* RPC Server side functions */
                    331: 
                    332: /*
1.6       misho     333:  * rpc_srv_initServer() - Init & create RPC Server
                    334:  *
1.14      misho     335:  * @InstID = Instance for authentication & recognition
1.1       misho     336:  * @concurentClients = Concurent clients at same time to this server
1.9       misho     337:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.3       misho     338:  * @csHost = Host name or address for bind server, if NULL any address
1.1       misho     339:  * @Port = Port for bind server, if Port == 0 default port is selected
1.12      misho     340:  * @proto = Protocol, if == 0 choose SOCK_STREAM
1.1       misho     341:  * return: NULL == error or !=NULL bind and created RPC server instance
                    342:  */
1.14      misho     343: rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, 
1.12      misho     344:                const char *csHost, unsigned short Port, int proto);
1.1       misho     345: /*
1.6       misho     346:  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
                    347:  *
1.5       misho     348:  * @psrv = RPC Server instance
1.1       misho     349:  * return: none
                    350:  */
1.15      misho     351: void rpc_srv_endServer(rpc_srv_t ** __restrict psrv);
1.1       misho     352: /*
1.6       misho     353:  * rpc_srv_loopServer() - Execute Main server loop and wait for clients requests
                    354:  *
1.1       misho     355:  * @srv = RPC Server instance
                    356:  * return: -1 error or 0 ok, infinite loop ...
                    357:  */
1.4       misho     358: int rpc_srv_loopServer(rpc_srv_t * __restrict srv);
1.9       misho     359: #define rpc_srv_execServer(_srv, _sync)        do { assert((_srv)); \
                    360:                                                if (!(_srv)->srv_kill) { \
                    361:                                                        pthread_create(&(_srv)->srv_tid, NULL, (void*(*)(void*)) \
                    362:                                                                        rpc_srv_loopServer, (_srv)); \
                    363:                                                        if ((_sync)) \
                    364:                                                                pthread_join((_srv)->srv_tid, (void**) (_sync)); \
                    365:                                                        else \
                    366:                                                                pthread_detach((_srv)->srv_tid); \
                    367:                                                } } while (0)
1.20.8.1! misho     368: #define rpc_srv_killServer(_srv)       (assert((_srv)), (_srv)->srv_blob.kill = 1, (_srv)->srv_kill = 1)
1.1       misho     369: 
                    370: /*
1.6       misho     371:  * rpc_srv_initBLOBServer() - Init & create BLOB Server
                    372:  *
1.3       misho     373:  * @srv = RPC server instance
1.2       misho     374:  * @Port = Port for bind server, if Port == 0 default port is selected
                    375:  * @diskDir = Disk place for BLOB file objects
                    376:  * return: -1 == error or 0 bind and created BLOB server instance
                    377:  */
1.9       misho     378: int rpc_srv_initBLOBServer(rpc_srv_t * __restrict srv, unsigned short Port, const char *diskDir);
1.2       misho     379: /*
1.6       misho     380:  * rpc_srv_endBLOBServer() - Destroy BLOB server, close all opened sockets and free resources
                    381:  *
1.2       misho     382:  * @srv = RPC Server instance
                    383:  * return: none
                    384:  */
1.15      misho     385: void rpc_srv_endBLOBServer(rpc_srv_t * __restrict srv);
1.2       misho     386: /*
1.6       misho     387:  * rpc_srv_loopBLOB() - Execute Main BLOB server loop and wait for clients requests
                    388:  *
1.2       misho     389:  * @srv = RPC Server instance
                    390:  * return: -1 error or 0 ok, infinite loop ...
                    391:  */
1.9       misho     392: int rpc_srv_loopBLOBServer(rpc_srv_t * __restrict srv);
                    393: #define rpc_srv_execBLOBServer(_srv)   do { assert((_srv)); \
                    394:                                                if (!(_srv)->srv_kill && !(_srv)->srv_blob.kill) { \
                    395:                                                        pthread_create(&(_srv)->srv_blob.tid, NULL, \
                    396:                                                                        (void*(*)(void*)) \
                    397:                                                                        rpc_srv_loopBLOBServer, (_srv)); \
                    398:                                                        pthread_detach((_srv)->srv_blob.tid); \
1.4       misho     399:                                                } \
                    400:                                        } while (0)
1.2       misho     401: 
                    402: /*
1.6       misho     403:  * rpc_srv_registerCall() - Register call to RPC server
                    404:  *
1.1       misho     405:  * @srv = RPC Server instance
1.9       misho     406:  * @tag = Function tag
                    407:  * @funcaddr = Function address
                    408:  * return: -1 error, 0 already registered tag or 1 register ok
1.1       misho     409:  */
1.9       misho     410: int rpc_srv_registerCall(rpc_srv_t * __restrict srv, unsigned short tag, void *funcaddr);
1.1       misho     411: /*
1.6       misho     412:  * rpc_srv_unregisterCall() - Unregister call from RPC server
                    413:  *
1.1       misho     414:  * @srv = RPC Server instance
1.9       misho     415:  * @tag = Function tag
1.1       misho     416:  * return: -1 error, 0 not found call, 1 unregister ok
                    417:  */
1.9       misho     418: int rpc_srv_unregisterCall(rpc_srv_t * __restrict srv, unsigned short tag);
1.1       misho     419: /*
1.9       misho     420:  * rpc_srv_getCall()  - Get registered call from RPC server
1.6       misho     421:  *
1.1       misho     422:  * @srv = RPC Server instance
                    423:  * @tag = tag for function
                    424:  * return: NULL not found call, !=NULL return call
                    425:  */
1.15      misho     426: rpc_func_t *rpc_srv_getCall(rpc_srv_t * __restrict srv, uint16_t tag);
1.1       misho     427: /*
1.9       misho     428:  * rpc_srv_execCall() Execute registered call from RPC server
1.6       misho     429:  *
1.9       misho     430:  * @cli = RPC client
1.1       misho     431:  * @rpc = IN RPC call structure
1.9       misho     432:  * @funcname = Execute RPC function
1.4       misho     433:  * @args = IN RPC calling arguments from RPC client
1.1       misho     434:  * return: -1 error, !=-1 ok
                    435:  */
1.9       misho     436: int rpc_srv_execCall(rpc_cli_t * __restrict cli, struct tagRPCCall * __restrict rpc, 
                    437:                ait_val_t funcname, array_t * __restrict args);
1.1       misho     438: 
                    439: 
1.2       misho     440: /*
1.9       misho     441:  * rpc_srv_blobCreate() - Create and map blob to memory region and return object
1.6       misho     442:  *
1.2       misho     443:  * @srv = RPC Server instance
                    444:  * @len = BLOB length object
1.16      misho     445:  * @tout = BLOB live timeout in seconds
1.2       misho     446:  * return: NULL error or !=NULL allocated BLOB object
                    447:  */
1.16      misho     448: rpc_blob_t *rpc_srv_blobCreate(rpc_srv_t * __restrict srv, int len, int tout);
1.2       misho     449: /*
1.6       misho     450:  * rpc_srv_blobMap() - Map blob to memory region 
                    451:  *
1.2       misho     452:  * @srv = RPC Server instance
                    453:  * @blob = Map to this BLOB element
                    454:  * return: -1 error or 0 ok
                    455:  */
1.15      misho     456: int rpc_srv_blobMap(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
1.2       misho     457: /*
1.6       misho     458:  * rpc_srv_blobUnmap() - Unmap blob memory region 
                    459:  *
1.2       misho     460:  * @blob = Mapped BLOB element
                    461:  * return: none
                    462:  */
1.15      misho     463: void rpc_srv_blobUnmap(rpc_blob_t * __restrict blob);
1.2       misho     464: /*
1.6       misho     465:  * rpc_srv_blobFree() - Free blob from disk & memory
                    466:  *
1.2       misho     467:  * @srv = RPC Server instance
                    468:  * @blob = Mapped BLOB element
                    469:  * return: -1 error or 0 ok
                    470:  */
1.15      misho     471: int rpc_srv_blobFree(rpc_srv_t * __restrict srv, rpc_blob_t * __restrict blob);
1.2       misho     472: 
                    473: /*
1.6       misho     474:  * rpc_srv_registerBLOB() - Register new BLOB to server
                    475:  *
1.2       misho     476:  * @srv = RPC Server instance
                    477:  * @len = BLOB length
1.16      misho     478:  * @tout = BLOB live timeout in seconds
1.2       misho     479:  * return: NULL error or new registered BLOB
                    480:  */
1.16      misho     481: rpc_blob_t *rpc_srv_registerBLOB(rpc_srv_t * __restrict srv, size_t len, int tout);
1.2       misho     482: /*
1.6       misho     483:  * rpc_srv_unregisterBLOB() - Unregister BLOB from server
                    484:  *
1.2       misho     485:  * @srv = RPC Server instance
                    486:  * @var = BLOB Variable for unregister
                    487:  * return: -1 error, 0 not found call, 1 unregister ok
                    488:  */
                    489: int rpc_srv_unregisterBLOB(rpc_srv_t * __restrict srv, uint32_t var);
                    490: /*
1.6       misho     491:  * rpc_srv_getBLOB() - Get registered BLOB 
                    492:  *
1.2       misho     493:  * @srv = RPC Server instance
                    494:  * @var = hash for variable
                    495:  * return: NULL not found, !=NULL return blob var
                    496:  */
1.15      misho     497: rpc_blob_t *rpc_srv_getBLOB(rpc_srv_t * __restrict srv, uint32_t var);
1.2       misho     498: 
                    499: /*
1.6       misho     500:  * rpc_srv_sendBLOB() - Send mapped BLOB to client
                    501:  *
1.2       misho     502:  * @cli = Client instance
                    503:  * @blob = Mapped BLOB element
                    504:  * return: -1 error, 0 ok
                    505:  */
                    506: int rpc_srv_sendBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    507: /*
1.6       misho     508:  * rpc_srv_recvBLOB() - Receive BLOB from client
                    509:  *
1.2       misho     510:  * @cli = Client instance
                    511:  * @blob = Mapped BLOB element
                    512:  * return: -1 error, 0 ok, >0 unreceived data from client, may be error?
                    513:  */
                    514: int rpc_srv_recvBLOB(rpc_cli_t * __restrict cli, rpc_blob_t * __restrict blob);
                    515: 
1.4       misho     516: /* CLIENT part of functions */
                    517: 
1.2       misho     518: /*
1.6       misho     519:  * rpc_cli_sendBLOB() - Send BLOB to server
                    520:  *
1.2       misho     521:  * @cli = Client instance
                    522:  * @var = BLOB variable
                    523:  * @data = BLOB data
1.16      misho     524:  * @tout = BLOB live on server timeout in seconds, if =0 default timeout
1.2       misho     525:  * return: -1 error, 0 ok, 1 remote error
                    526:  */
1.16      misho     527: int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
                    528:                void * __restrict data, int tout);
1.2       misho     529: /*
1.6       misho     530:  * rpc_cli_recvBLOB() - Receive BLOB from server
                    531:  *
1.2       misho     532:  * @cli = Client instance
                    533:  * @var = BLOB variable
1.13      misho     534:  * @data = BLOB data, must be e_free after use!
1.2       misho     535:  * return: -1 error, 0 ok, 1 remote error
                    536:  */
1.4       misho     537: int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
1.2       misho     538: /*
1.6       misho     539:  * rpc_cli_delBLOB() - Delete BLOB from server
                    540:  *
1.2       misho     541:  * @cli = Client instance
                    542:  * @var = BLOB variable
                    543:  * return: -1 error, 0 ok, 1 remote error
                    544:  */
1.4       misho     545: int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var);
1.2       misho     546: /*
1.6       misho     547:  * rpc_cli_getBLOB() - Receive BLOB from server and Delete after that.
                    548:  *
1.2       misho     549:  * @cli = Client instance
                    550:  * @var = BLOB variable
1.13      misho     551:  * @data = BLOB data, must be e_free after use!
1.2       misho     552:  * return: -1 error, 0 ok, >0 remote error
                    553:  */
1.15      misho     554: int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
1.6       misho     555:                void ** __restrict data);
1.2       misho     556: 
                    557: 
1.1       misho     558: /* RPC Client side functions */
                    559: 
                    560: /*
1.6       misho     561:  * rpc_cli_openClient() - Connect to RPC Server
                    562:  *
1.14      misho     563:  * @InstID = InstID for RPC session request
1.9       misho     564:  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
1.1       misho     565:  * @csHost = Host name or IP address for bind server
                    566:  * @Port = Port for bind server, if Port == 0 default port is selected
1.12      misho     567:  * @proto = Protocol, if == 0 choose SOCK_STREAM
1.1       misho     568:  * return: NULL == error or !=NULL connection to RPC server established
                    569:  */
1.14      misho     570: rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, 
1.12      misho     571:                const char *csHost, unsigned short Port, int proto);
1.1       misho     572: /*
1.6       misho     573:  * rpc_cli_closeClient() - Close connection to RPC server and free resources
                    574:  *
1.1       misho     575:  * @cli = RPC Client session
                    576:  * return: none
                    577:  */
1.9       misho     578: void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
1.1       misho     579: /*
1.13      misho     580:  * rpc_pkt_Send() - Send RPC packet
                    581:  *
                    582:  * @sock = Socket
                    583:  * @type = Type of socket
                    584:  * @sa = Server address
                    585:  * @pkt = RPC packet
                    586:  * @len = Length of packet
                    587:  * return: -1 error or !=-1 sended bytes
                    588:  */
                    589: int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, 
                    590:                ait_val_t * __restrict pkt, int len);
                    591: /*
                    592:  * rpc_pkt_Receive() - Receive RPC packet
                    593:  *
                    594:  * @sock = Socket
                    595:  * @type = Type of socket
                    596:  * @sa = Server address
                    597:  * @pkt = RPC packet
                    598:  * return: -1 error or !=-1 sended bytes
                    599:  */
                    600: int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, 
                    601:                ait_val_t * __restrict pkt);
                    602: /*
                    603:  * rpc_pkt_Request() - Build RPC Request packet
                    604:  *
                    605:  * @pkt = Packet buffer
                    606:  * @sess = RPC session info
                    607:  * @tag = Function tag for execution
                    608:  * @vars = Function argument array of values, may be NULL
                    609:  * @noreply = We not want RPC reply
1.14      misho     610:  * @nocrc = Without CRC calculation
1.13      misho     611:  * return: -1 error or != -1 prepared bytes into packet
                    612:  */
                    613: int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
1.14      misho     614:                unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
1.13      misho     615: /*
                    616:  * rpc_pkt_Replay() - Decode RPC Replay packet
                    617:  *
                    618:  * @pkt = Packet buffer
                    619:  * @sess = RPC session info
                    620:  * @tag = Function tag
                    621:  * @vars = Function argument array of values, may be NULL
1.14      misho     622:  * @nocrc = Without CRC calculation
1.13      misho     623:  * return: -1 error or != -1 return value from function
                    624:  */
                    625: int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
1.14      misho     626:                unsigned short tag, array_t ** __restrict vars, int nocrc);
1.13      misho     627: /*
1.6       misho     628:  * rpc_cli_execCall() - Execute RPC call
                    629:  *
1.1       misho     630:  * @cli = RPC Client session
1.7       misho     631:  * @noreply = We not want RPC reply
1.9       misho     632:  * @tag = Function tag for execution
1.13      misho     633:  * @in_vars = IN function argument array of values, may be NULL
                    634:  * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
1.1       misho     635:  * return: -1 error or != -1 ok result
                    636:  */
1.9       misho     637: int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, 
1.4       misho     638:                array_t * __restrict in_vars, array_t ** __restrict out_vars);
1.9       misho     639: /*
1.11      misho     640:  * rpc_cli_freeCall() - Free resouce allocated by RPC call
                    641:  *
                    642:  * @out_vars = Returned array with variables from RPC call
                    643:  * return: none
                    644:  */
1.15      misho     645: void rpc_cli_freeCall(array_t ** __restrict out_vars);
1.11      misho     646: /*
1.9       misho     647:  * rpc_cli_ping() - Ping RPC server
                    648:  *
                    649:  * @cli = connected client
                    650:  * return: -1 error or !=-1 ping seq id
                    651:  */
1.15      misho     652: int rpc_cli_ping(rpc_cli_t *cli);
1.1       misho     653: 
                    654: 
1.2       misho     655: /*
1.6       misho     656:  * rpc_cli_openBLOBClient() - Connect to BLOB Server
                    657:  *
1.2       misho     658:  * @rpccli = RPC Client session
                    659:  * @Port = Port for bind server, if Port == 0 default port is selected
                    660:  * return: NULL == error or !=NULL connection to BLOB server established
                    661:  */
1.9       misho     662: rpc_cli_t *rpc_cli_openBLOBClient(rpc_cli_t * __restrict rpccli, unsigned short Port);
1.2       misho     663: /*
1.6       misho     664:  * rpc_cli_closeBLOBClient() - Close connection to BLOB server and free resources
                    665:  *
1.2       misho     666:  * @cli = BLOB Client session
                    667:  * return: none
                    668:  */
1.9       misho     669: void rpc_cli_closeBLOBClient(rpc_cli_t ** __restrict cli);
1.2       misho     670: 
                    671: 
1.1       misho     672: #endif

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