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

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

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