[BACK]Return to aitrpc.h CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / libaitrpc / inc

Diff for /libaitrpc/inc/aitrpc.h between versions 1.11.2.1 and 1.14

version 1.11.2.1, 2012/11/16 08:33:06 version 1.14, 2013/04/02 15:50:14
Line 12  terms: Line 12  terms:
 All of the documentation and software included in the ELWIX and AITNET  All of the documentation and software included in the ELWIX and AITNET
 Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>  Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
   
Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
         by Michael Pounov <misho@elwix.org>.  All rights reserved.          by Michael Pounov <misho@elwix.org>.  All rights reserved.
   
 Redistribution and use in source and binary forms, with or without  Redistribution and use in source and binary forms, with or without
Line 58  SUCH DAMAGE. Line 58  SUCH DAMAGE.
 #endif  #endif
 #include <sys/socket.h>  #include <sys/socket.h>
 #include <sys/queue.h>  #include <sys/queue.h>
#include <aitio.h>#include <elwix.h>
 #include <aitsched.h>  #include <aitsched.h>
   
   
#define RPC_VERSION             4#define RPC_VERSION             6
 #define RPC_DEFPORT             2611  #define RPC_DEFPORT             2611
   
 /* RPC call request flags */  /* RPC call request flags */
Line 91  SUCH DAMAGE. Line 91  SUCH DAMAGE.
 typedef enum {  typedef enum {
         ok, error, no,                          /* for blob reply */          ok, error, no,                          /* for blob reply */
         get, set, unset                         /* for blob request */          get, set, unset                         /* for blob request */
} cmd_type_t;} blob_cmd_type_t;
   
   
 #define RPC_CALLBACK_CHECK_INPUT(x)     do { \  #define RPC_CALLBACK_CHECK_INPUT(x)     do { \
Line 107  typedef enum { Line 107  typedef enum {
 /* RPC session identification */  /* RPC session identification */
   
 typedef struct {  typedef struct {
        uint8_t             sess_version;#if BYTE_ORDER == LITTLE_ENDIAN
        uint32_t      sess_program;        uint16_t    sess_instance:8;
        uint8_t             sess_process;        uint16_t        sess_version:8;
} __packed rpc_sess_t;          /* size == 6 bytes */#endif
 #if BYTE_ORDER == BIG_ENDIAN
         uint16_t      sess_version:8;
         uint16_t        sess_instance:8;
 #endif
 } __packed rpc_sess_t;  /* size == 2 bytes */
   
   
 /* Server managment RPC functions ... */  /* Server managment RPC functions ... */
Line 137  struct tagRPCCall { Line 142  struct tagRPCCall {
         uint16_t        call_tag;          uint16_t        call_tag;
         uint16_t        call_argc;          uint16_t        call_argc;
         ait_val_t       call_argv[0];          ait_val_t       call_argv[0];
} __packed;                     /* size == 24 bytes */} __packed;                     /* size == 20 bytes */
 #define RPC_CHK_NOREPLY(x)      ((x)->call_req.flags & RPC_NOREPLY)  #define RPC_CHK_NOREPLY(x)      ((x)->call_req.flags & RPC_NOREPLY)
   
 /* Network BLOB packet - Header */  /* Network BLOB packet - Header */
Line 148  struct tagBLOBHdr { Line 153  struct tagBLOBHdr {
         uint32_t        hdr_var;          uint32_t        hdr_var;
         uint32_t        hdr_len;          uint32_t        hdr_len;
         uint32_t        hdr_ret;          uint32_t        hdr_ret;
         uint16_t        hdr_crc;  
         uint8_t         hdr_pad;          uint8_t         hdr_pad;
} __packed;                     /* size == 22 bytes */} __packed;                     /* size == 16 bytes */
   
 /* Network RPC client & server elements */  /* Network RPC client & server elements */
   
Line 191  typedef struct tagBLOB { Line 195  typedef struct tagBLOB {
 typedef struct {  typedef struct {
         int             cli_id;         /* slot id */          int             cli_id;         /* slot id */
         int             cli_sock;       /* socket fd */          int             cli_sock;       /* socket fd */
        io_sockaddr_t      cli_sa;         /* host address */        sockaddr_t      cli_sa;         /* host address */
         ait_val_t       cli_buf;        /* network buffer */          ait_val_t       cli_buf;        /* network buffer */
   
         array_t         *cli_vars;      /* function return variables */          array_t         *cli_vars;      /* function return variables */
Line 296  int rpc_register_blobServices(rpc_srv_t * __restrict s Line 300  int rpc_register_blobServices(rpc_srv_t * __restrict s
 /*  /*
  * rpc_srv_initServer() - Init & create RPC Server   * rpc_srv_initServer() - Init & create RPC Server
  *   *
 * @regProgID = ProgramID for authentication & recognition * @InstID = Instance for authentication & recognition
 * @regProcID = ProcessID for authentication & recognition 
  * @concurentClients = Concurent clients at same time to this server   * @concurentClients = Concurent clients at same time to this server
  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)   * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  * @csHost = Host name or address for bind server, if NULL any address   * @csHost = Host name or address for bind server, if NULL any address
  * @Port = Port for bind server, if Port == 0 default port is selected   * @Port = Port for bind server, if Port == 0 default port is selected
 * @proto = Protocol, if == 0 choose IPPROTO_TCP * @proto = Protocol, if == 0 choose SOCK_STREAM
  * return: NULL == error or !=NULL bind and created RPC server instance   * return: NULL == error or !=NULL bind and created RPC server instance
  */   */
rpc_srv_t *rpc_srv_initServer(unsigned int regProgID, unsigned char regProcID, rpc_srv_t *rpc_srv_initServer(unsigned char InstID, int concurentClients, int netBuf, 
                int concurentClients, int netBuf,  
                 const char *csHost, unsigned short Port, int proto);                  const char *csHost, unsigned short Port, int proto);
 /*  /*
  * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources   * rpc_srv_endServer() - Destroy RPC server, close all opened sockets and free resources
Line 492  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v Line 494  int rpc_cli_sendBLOB(rpc_cli_t * __restrict cli, ait_v
  *   *
  * @cli = Client instance   * @cli = Client instance
  * @var = BLOB variable   * @var = BLOB variable
 * @data = BLOB data, must be io_free after use! * @data = BLOB data, must be e_free after use!
  * return: -1 error, 0 ok, 1 remote error   * return: -1 error, 0 ok, 1 remote error
  */   */
 int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);  int rpc_cli_recvBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, void ** __restrict data);
Line 509  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va Line 511  int rpc_cli_delBLOB(rpc_cli_t * __restrict cli, ait_va
  *   *
  * @cli = Client instance   * @cli = Client instance
  * @var = BLOB variable   * @var = BLOB variable
 * @data = BLOB data, must be io_free after use! * @data = BLOB data, must be e_free after use!
  * return: -1 error, 0 ok, >0 remote error   * return: -1 error, 0 ok, >0 remote error
  */   */
 inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var,   inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, ait_val_t * __restrict var, 
Line 521  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli, Line 523  inline int rpc_cli_getBLOB(rpc_cli_t * __restrict cli,
 /*  /*
  * rpc_cli_openClient() - Connect to RPC Server   * rpc_cli_openClient() - Connect to RPC Server
  *   *
 * @ProgID = ProgramID for RPC session request * @InstID = InstID for RPC session request
 * @ProcID = ProcessID for RPC session request 
  * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)   * @netBuf = Network buffer length (min:512 bytes), if =0 == BUFSIZ (also meaning max RPC packet)
  * @csHost = Host name or IP address for bind server   * @csHost = Host name or IP address for bind server
  * @Port = Port for bind server, if Port == 0 default port is selected   * @Port = Port for bind server, if Port == 0 default port is selected
    * @proto = Protocol, if == 0 choose SOCK_STREAM
  * return: NULL == error or !=NULL connection to RPC server established   * return: NULL == error or !=NULL connection to RPC server established
  */   */
rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, unsigned char ProcID, int netBuf, rpc_cli_t *rpc_cli_openClient(unsigned char InstID, int netBuf, 
                const char *csHost, unsigned short Port);                const char *csHost, unsigned short Port, int proto);
 /*  /*
  * rpc_cli_closeClient() - Close connection to RPC server and free resources   * rpc_cli_closeClient() - Close connection to RPC server and free resources
  *   *
Line 538  rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns Line 540  rpc_cli_t *rpc_cli_openClient(unsigned int ProgID, uns
  */   */
 void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);  void rpc_cli_closeClient(rpc_cli_t ** __restrict cli);
 /*  /*
    * rpc_pkt_Send() - Send RPC packet
    *
    * @sock = Socket
    * @type = Type of socket
    * @sa = Server address
    * @pkt = RPC packet
    * @len = Length of packet
    * return: -1 error or !=-1 sended bytes
    */
   int rpc_pkt_Send(int sock, int type, sockaddr_t * __restrict sa, 
                   ait_val_t * __restrict pkt, int len);
   /*
    * rpc_pkt_Receive() - Receive RPC packet
    *
    * @sock = Socket
    * @type = Type of socket
    * @sa = Server address
    * @pkt = RPC packet
    * return: -1 error or !=-1 sended bytes
    */
   int rpc_pkt_Receive(int sock, int type, sockaddr_t * __restrict sa, 
                   ait_val_t * __restrict pkt);
   /*
    * rpc_pkt_Request() - Build RPC Request packet
    *
    * @pkt = Packet buffer
    * @sess = RPC session info
    * @tag = Function tag for execution
    * @vars = Function argument array of values, may be NULL
    * @noreply = We not want RPC reply
    * @nocrc = Without CRC calculation
    * return: -1 error or != -1 prepared bytes into packet
    */
   int rpc_pkt_Request(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
                   unsigned short tag, array_t * __restrict vars, int noreply, int nocrc);
   /*
    * rpc_pkt_Replay() - Decode RPC Replay packet
    *
    * @pkt = Packet buffer
    * @sess = RPC session info
    * @tag = Function tag
    * @vars = Function argument array of values, may be NULL
    * @nocrc = Without CRC calculation
    * return: -1 error or != -1 return value from function
    */
   int rpc_pkt_Replay(ait_val_t * __restrict pkt, rpc_sess_t * __restrict sess, 
                   unsigned short tag, array_t ** __restrict vars, int nocrc);
   /*
  * rpc_cli_execCall() - Execute RPC call   * rpc_cli_execCall() - Execute RPC call
  *   *
  * @cli = RPC Client session   * @cli = RPC Client session
  * @noreply = We not want RPC reply   * @noreply = We not want RPC reply
  * @tag = Function tag for execution   * @tag = Function tag for execution
 * @in_vars = IN RPC call array of rpc values, may be NULL * @in_vars = IN function argument array of values, may be NULL
 * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with io_freeVars() * @out_vars = OUT returned array of rpc values, if !=NULL must be free after use with ait_freeVars()
  * return: -1 error or != -1 ok result   * return: -1 error or != -1 ok result
  */   */
 int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag,   int rpc_cli_execCall(rpc_cli_t *cli, int noreply, unsigned short tag, 
Removed from v.1.11.2.1  
changed lines
  Added in v.1.14

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