cueOS  2.4
cueOS - Universal Show Control OS for ARM
Definitions
Collaboration diagram for Definitions:

Macros

#define STR_COMMON_SP   " "
 
#define STR_COMMON_CRLF   "\r\n"
 
#define STR_COMMON_QMRK   "?"
 
#define STR_COMMON_EQUL   "="
 
#define STR_COMMON_AMPR   "&"
 

Enumerations

enum  http_status_code_e {
  HTTP_STATUS_CODE_200 ,
  HTTP_STATUS_CODE_201 ,
  HTTP_STATUS_CODE_202 ,
  HTTP_STATUS_CODE_204 ,
  HTTP_STATUS_CODE_300 ,
  HTTP_STATUS_CODE_301 ,
  HTTP_STATUS_CODE_400 ,
  HTTP_STATUS_CODE_401 ,
  HTTP_STATUS_CODE_403 ,
  HTTP_STATUS_CODE_404 ,
  HTTP_STATUS_CODE_405 ,
  HTTP_STATUS_CODE_501 ,
  HTTP_STATUS_CODE_502 ,
  HTTP_STATUS_CODE_503
}
 Enumeration of HTTP status codes string indexes. More...
 
enum  http_header_field_e {
  HTTP_HEADER_FIELD_STATUS_CODE ,
  HTTP_HEADER_FIELD_CONTENT_TYPE ,
  HTTP_HEADER_FIELD_CONTENT_LENGTH ,
  HTTP_HEADER_FIELD_CONTENT_ENCODING ,
  HTTP_HEADER_FIELD_CONTENT_LANGUAGE ,
  HTTP_HEADER_FIELD_CONTENT_LOCATION
}
 Enumeration of HTTP header fields string indexes. More...
 
enum  http_content_types_e {
  HTTP_CONTENT_TYPE_PLAIN ,
  HTTP_CONTENT_TYPE_HTML ,
  HTTP_CONTENT_TYPE_JSON
}
 Enumeration of HTTP content-types header values string indexes. More...
 
enum  http_method_e {
  HTTP_GET ,
  HTTP_POST ,
  HTTP_PUT ,
  HTTP_PATCH ,
  HTTP_DELETE
}
 Enumeration of HTTP method string indexes. More...
 
enum  http_version_e {
  HTTP_VERSION_0_9 ,
  HTTP_VERSION_1_1 ,
  HTTP_VERSION_2_0
}
 Enumeration of HTTP versions string indexes. More...
 

Variables

static char *const http_status_codes_str []
 list of HTTP status codes strings. More...
 
static char *const http_header_field_str []
 list of HTTP header fields strings. More...
 
static char *const http_content_types_str []
 list of HTTP content-types header values strings. More...
 
static const char *const http_methods []
 list of HTTP method strings. More...
 
static const char *const http_versions []
 list of HTTP versions strings. More...
 

Detailed Description

Definition of fundamental constant values to be used within the HTTP module

Macro Definition Documentation

◆ STR_COMMON_AMPR

#define STR_COMMON_AMPR   "&"

common string separator value - Ampersand

Definition at line 15 of file http_defs.h.

◆ STR_COMMON_CRLF

#define STR_COMMON_CRLF   "\r\n"

common string separator value - CRLF

Definition at line 12 of file http_defs.h.

◆ STR_COMMON_EQUL

#define STR_COMMON_EQUL   "="

common string separator value - Equal sign

Definition at line 14 of file http_defs.h.

◆ STR_COMMON_QMRK

#define STR_COMMON_QMRK   "?"

common string separator value - Question mark

Definition at line 13 of file http_defs.h.

◆ STR_COMMON_SP

#define STR_COMMON_SP   " "

common string separator value - Space

Definition at line 11 of file http_defs.h.

Enumeration Type Documentation

◆ http_content_types_e

Enumeration of HTTP content-types header values string indexes.

Enumerator
HTTP_CONTENT_TYPE_PLAIN 

HTTP Plain content type header value string index

HTTP_CONTENT_TYPE_HTML 

HTTP HTML content type header value string index

HTTP_CONTENT_TYPE_JSON 

HTTP JSON content type header value string index

Definition at line 53 of file http_defs.h.

◆ http_header_field_e

Enumeration of HTTP header fields string indexes.

Enumerator
HTTP_HEADER_FIELD_STATUS_CODE 

HTTP status code header field string index

HTTP_HEADER_FIELD_CONTENT_TYPE 

HTTP content type header field string index

HTTP_HEADER_FIELD_CONTENT_LENGTH 

HTTP content length header field string index

HTTP_HEADER_FIELD_CONTENT_ENCODING 

HTTP content encoding header field string index

HTTP_HEADER_FIELD_CONTENT_LANGUAGE 

HTTP content manguage header field string index

HTTP_HEADER_FIELD_CONTENT_LOCATION 

HTTP content location header field string index

Definition at line 41 of file http_defs.h.

◆ http_method_e

Enumeration of HTTP method string indexes.

Enumerator
HTTP_GET 

HTTP GET method string index

HTTP_POST 

HTTP POST method string index

HTTP_PUT 

HTTP PUT method string index

HTTP_PATCH 

HTTP PATCH method string index

HTTP_DELETE 

HTTP DELETE method string index

Definition at line 62 of file http_defs.h.

◆ http_status_code_e

Enumeration of HTTP status codes string indexes.

Enumerator
HTTP_STATUS_CODE_200 

HTTP 200 OK status code

HTTP_STATUS_CODE_201 

HTTP 201 status code

HTTP_STATUS_CODE_202 

HTTP 202 status code

HTTP_STATUS_CODE_204 

HTTP 204 status code

HTTP_STATUS_CODE_300 

HTTP 300 status code

HTTP_STATUS_CODE_301 

HTTP 301 status code

HTTP_STATUS_CODE_400 

HTTP 400 status code

HTTP_STATUS_CODE_401 

HTTP 401 status code

HTTP_STATUS_CODE_403 

HTTP 403 status code

HTTP_STATUS_CODE_404 

HTTP 404 Not Found status code

HTTP_STATUS_CODE_405 

HTTP 405 Method Not Allowed

HTTP_STATUS_CODE_501 

HTTP 501 status code

HTTP_STATUS_CODE_502 

HTTP 502 status code

HTTP_STATUS_CODE_503 

HTTP 503 status code

Definition at line 21 of file http_defs.h.

◆ http_version_e

Enumeration of HTTP versions string indexes.

Enumerator
HTTP_VERSION_0_9 

HTTP/0.9 version string index

HTTP_VERSION_1_1 

HTTP/1.1 version string index

HTTP_VERSION_2_0 

HTTP/2.0 version string index

Definition at line 73 of file http_defs.h.

Variable Documentation

◆ http_content_types_str

char* const http_content_types_str[]
static
Initial value:
= {
"text/plain",
"text/html",
"application/json; charset=UTF8",
}

list of HTTP content-types header values strings.

Definition at line 115 of file http_defs.h.

◆ http_header_field_str

char* const http_header_field_str[]
static
Initial value:
= {
"HTTP/1.1 ",
"Content-Type: ",
"Content-Length: ",
"Content-Encoding: ",
"Content-Language: ",
"Content-Location: ",
}

list of HTTP header fields strings.

Definition at line 103 of file http_defs.h.

◆ http_methods

const char* const http_methods[]
static
Initial value:
= {
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
}

list of HTTP method strings.

Definition at line 124 of file http_defs.h.

◆ http_status_codes_str

char* const http_status_codes_str[]
static
Initial value:
= {
"200 OK",
"201 Created",
"Accepted",
"No Content",
"300 Multiple Choices",
"301 Moved Permanently",
"400 Bad Request",
"401 Unauthorized",
"403 Forbidden",
"404 Not Found",
"405 Method Not Allowed",
"501 Not Implemented",
"502 Bad Gateway",
"503 Service Unavailable"
}

list of HTTP status codes strings.

Definition at line 83 of file http_defs.h.

◆ http_versions

const char* const http_versions[]
static
Initial value:
= {
"HTTP/0.9",
"HTTP/1.1",
"HTTP/2.0"
}

list of HTTP versions strings.

Definition at line 135 of file http_defs.h.