types.h

Go to the documentation of this file.

#ifndef EVE_HTTP_TYPES_H_INCLUDED
#define EVE_HTTP_TYPES_H_INCLUDED

/**
 * @file http/types.h
 * @brief HTTP module basic types
 */

#include <toc/types.h>

/**
 * \addtogroup http
 * \{
 */

/**
 * Convert a string literal to a string / length pair
 *
 * \param x the string literal
 */
#define CSTRING(x)  (x), (sizeof(x) - 1)

/**
 * String convert entry initializer macro.
 * \param v numerical identifier
 * \param s corresponding string literal
 */
#define ENUM_CVT_ENTRY(v, s) {  \
  .String = (s),                \
  .Length = sizeof(s) - 1,      \
  .Value = (v)                  \
}


/**
 * Content type flags for fine tunung of HTTP response headers
 */
enum http_content_type_flags_t
{
  FILE_FLAGS_DEFAULT    = 0,              /**< Defailt flags, no options set */
  FILE_FLAGS_GZIP       = (1 << 0),       /**< Set "Content-Encoding: gzip" HTTP header */
  FILE_FLAGS__FIRST_SYSTEM = (1 << 1),    /**< First system flag */
};

/**
 * Entry of \ref HttpContentTypeTable table.
 */
struct http_content_type_t
{
  const char *String;                     /**< Pointer to the content-type string */
  uint16_t Length;                        /**< Length of the content-type string */
  uint16_t Flags;                         /**< \ref http_content_type_flags_t */
};

/**
 * String convert table entry.
 *
 * The entry sets association between a string and a coressponding numerical identifier.
 */
struct http_enum_cvt_t
{
  const char *String;                     /**< Pointer to a string */
  uint16_t Length;                        /**< Length of the string */
  uint16_t Value;                         /**< Numerical identifier associated with the string */
};

/**
 * HTTP request identifier type
 *
 * The engine supports up to 254 unique requests,
 * each of them is mapped to the corresponding ID.
 */
enum http_req_type_t
{
  HTTP_REQ_TOC,                           /**< /json/toc.json */
  HTTP_REQ_GET,                           /**< /json/get.json */
  HTTP_REQ_SET,                           /**< /json/set.json */
  HTTP_REQ_PULL,                          /**< /json/pull.json?Resource */
  HTTP_REQ_PUSH,                          /**< /json/push.json?Resource */
  HTTP_REQ_STREAM,                        /**< /json/stream.json */
  HTTP_REQ__SYSTEM_END = HTTP_REQ_STREAM, /**< Marks where the system resources ends */
  HTTP_REQ_UNKNOWN = 255,                 /**< Invalid or unknown request */
};

/**
 * System part of HTTP resource identifier type
 *
 * The only defined resource on the system level is an unknown one.
 */
enum
{
  HTTP_RESOURCE_UNKNOWN = 255,            /**< Unknown or invalid resource */
};

/**
 * Pointer to the data in a JSON segment
 */
struct toc_segment_ptr_t
{
  uint32_t Type;                          /**< Type of segment, typically enum toc_segment_type_t
                                           *   and (user-defined) app_segment_type_t */
  union
  {
    void *Pointer;                        /**< Pointer representation of the address */
    uint32_t Offset;                      /**< Offset representation of the address */
  } Address;                              /**< Address of a variable in the segment */
  void *DirectAddress;                    /**< Pointer to the dynamically allocated segment start */

  struct toc_blob_t Blob;
};

/**
 * User-defined context of TOC GET or set operations
 */
struct app_var_context_t;                 

/**
 * System context of TOC SET operations
 */
struct toc_var_context_t
{
  struct toc_segment_ptr_t Cursor;        /**< Current pointer on the segment */
  struct app_var_context_t *User;         /**< User data */
};

/**
 * Number of elements in the HttpReqTypeTable table
 */
extern const uint8_t HttpRequestCount; /* = HTTP_REQ__COUNT */

/**
 * Number of elements in the HttpResourceTable table
 */
extern const uint8_t HttpStaticResourceCount; /* = HTTP_RESOURCE__COUNT */

/**
 * User-defined content type mapping table
 */
extern const struct http_content_type_t HttpContentTypeTable[/*HTTP_RESOURCE__COUNT*/];

/**
 * User-defined request to ID mapping table
 */
extern const struct http_enum_cvt_t HttpReqTypeTable[/*HTTP_REQ__COUNT*/];

/**
 * User-defined resource to ID mapping table
 */
extern const struct http_enum_cvt_t HttpResourceTable[/*HTTP_RESOURCE__COUNT*/];

/** @} */

#endif