lwes_types.h

Go to the documentation of this file.

/*======================================================================*
 * Copyright (C) 2008 Light Weight Event System                         *
 * All rights reserved.                                                 *
 *                                                                      *
 * This program is free software; you can redistribute it and/or modify *
 * it under the terms of the GNU General Public License as published by *
 * the Free Software Foundation; either version 2 of the License, or    *
 * (at your option) any later version.                                  *
 *                                                                      *
 * This program is distributed in the hope that it will be useful,      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
 * GNU General Public License for more details.                         *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with this program; if not, write to the Free Software          *
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,                   *
 * Boston, MA 02110-1301 USA.                                           *
 *======================================================================*/
#ifndef __LWES_TYPES_H
#define __LWES_TYPES_H

#include <sys/types.h> /* for size_t in cygwin */
#include <netinet/in.h>

#ifdef __cplusplus
extern "C" {
#endif 

/* I wanted mainpage documentation somewhere, so this is the best place
   I can think of
 */

/* Now here is the documentat for this file */

typedef unsigned char      LWES_BYTE;

typedef unsigned char *    LWES_BYTE_P;

typedef unsigned short int LWES_U_INT_16;

typedef short int          LWES_INT_16;

typedef unsigned int       LWES_U_INT_32;

typedef int                LWES_INT_32;

typedef unsigned long long LWES_U_INT_64;

typedef long long          LWES_INT_64;

typedef int                LWES_BOOLEAN;

typedef struct in_addr     LWES_IP_ADDR;

typedef char *             LWES_SHORT_STRING;

typedef char *             LWES_LONG_STRING;

typedef const char *       LWES_CONST_SHORT_STRING;

typedef const char *       LWES_CONST_LONG_STRING;

typedef char               LWES_CHAR;

/* Maximums of each type in characters for a standard encoding */
/* WARNING, WARNING
   These #define's should be considered deprecated, they will be removed
   in a future version of lwes */
#define SHORT_STRING_MAX    255   /*                                          */
#define LONG_STRING_MAX     65535 /*                                          */
#define BYTE_STRING_MAX     2     /*                   00 - FF                */
#define U_INT_16_STRING_MAX 5     /*                    0 - 65535             */
#define INT_16_STRING_MAX   6     /*               -32768 - 32767             */
#define U_INT_32_STRING_MAX 10    /*                    0 - 4294967295        */
#define INT_32_STRING_MAX   11    /*          -2147483648 - 2147483647        */
#define U_INT_64_STRING_MAX 20    /*                  0 - 18446744073709551615*/
#define INT_64_STRING_MAX   20    /*-9223372036854775808 - 9223372036854775807*/
#define BOOLEAN_STRING_MAX  5     /*                 true - false             */
#define IP_ADDR_STRING_MAX  15    /*               xxx.xxx.xxx.xxx            */

#define MAX_HEADER_LENGTH   22
#define MAX_BODY_LENGTH     65513  /* 65535 - 22                              */

#ifndef TRUE
#define TRUE 1
#endif
#ifndef FALSE
#define FALSE 0
#endif
extern const size_t MAX_QUEUED_ELEMENTS;
extern const size_t MAX_MSG_SIZE;

/* TODO: these really need to go away and be replaced with the type enumeration
   below, until then they need to remain in-sync.
 */
extern const LWES_BYTE LWES_UNDEFINED_TOKEN;
extern const LWES_BYTE LWES_U_INT_16_TOKEN;
extern const LWES_BYTE LWES_INT_16_TOKEN;
extern const LWES_BYTE LWES_U_INT_32_TOKEN;
extern const LWES_BYTE LWES_INT_32_TOKEN;
extern const LWES_BYTE LWES_U_INT_64_TOKEN;
extern const LWES_BYTE LWES_INT_64_TOKEN;
extern const LWES_BYTE LWES_BOOLEAN_TOKEN;
extern const LWES_BYTE LWES_IP_ADDR_TOKEN;
extern const LWES_BYTE LWES_STRING_TOKEN;

extern const LWES_SHORT_STRING LWES_UNDEFINED_STRING;
extern const LWES_SHORT_STRING LWES_U_INT_16_STRING;
extern const LWES_SHORT_STRING LWES_INT_16_STRING;
extern const LWES_SHORT_STRING LWES_U_INT_32_STRING;
extern const LWES_SHORT_STRING LWES_INT_32_STRING;
extern const LWES_SHORT_STRING LWES_U_INT_64_STRING;
extern const LWES_SHORT_STRING LWES_INT_64_STRING;
extern const LWES_SHORT_STRING LWES_BOOLEAN_STRING;
extern const LWES_SHORT_STRING LWES_IP_ADDR_STRING;
extern const LWES_SHORT_STRING LWES_STRING_STRING;

extern const LWES_SHORT_STRING LWES_META_INFO_STRING;

typedef enum {
    LWES_TYPE_U_INT_16  = 1,   
    LWES_TYPE_INT_16    = 2,   
    LWES_TYPE_U_INT_32  = 3,   
    LWES_TYPE_INT_32    = 4,   
    LWES_TYPE_STRING    = 5,   
    LWES_TYPE_IP_ADDR   = 6,   
    LWES_TYPE_INT_64    = 7,   
    LWES_TYPE_U_INT_64  = 8,   
    LWES_TYPE_BOOLEAN   = 9,   
    LWES_TYPE_UNDEFINED = 255, 
} LWES_TYPE;

#ifdef __cplusplus
}
#endif 

#endif /* __LWES_TYPES_H */

---