docs/hdk/_n_e_t___h_t_t_p_defines_8h_source.html

/*

 * PROPRIETARY INFORMATION.  This software is proprietary to

 * Side Effects Software Inc., and is not to be reproduced,

 * transmitted, or disclosed in any way without written permission.

 *

 * COMMENTS:

 *

 *          Common. Commong HTTP defines (NET_HTTPDefines.h)

 */


#ifndef __NET_HTTPDefines_H__

#define __NET_HTTPDefines_H__


// Useful defines

#define HTTP_MAX_HEADER_SIZE 8000 //8kb

#define NET_IS_LOOPBACK_ADDRESS(_arr_)                                          \

    (_arr_[0] == 127 && _arr_[1] == 0 && (_arr_[2] == 0 || _arr_[2] == 1) &&   \

     _arr_[3] == 1)


//

// HTTP Functions

//

#define NET_COMMAND_FUNC_NAME "cmd_function"


//

// HTTP Methods

//

#define HTTP_METHOD_POST "POST"

#define HTTP_METHOD_GET "GET"

#define HTTP_METHOD_OPTIONS "OPTIONS"

#define HTTP_METHOD_PUT "PUT"


//

// Mime Defines

//

#define HTTP_MIME_JSON      "application/json"

#define HTTP_MIME_XML       "text/xml"

#define HTTP_MIME_TEXT      "text/plain"

#define HTTP_MIME_HTML      "text/html"

#define HTTP_MIME_JS        "text/javascript"

#define HTTP_MIME_CSS       "text/css"

#define HTTP_MIME_URL       "application/x-www-form-urlencoded"

#define HTTP_MIME_MULTIPART "multipart/form-data"

#define HTTP_MIME_BINARY    "application/octet-stream"

#define HTTP_MIME_MP4       "video/mp4"

#define HTTP_MIME_MP3       "video/mp3"

#define HTTP_MIME_OGG       "video/ogg"

#define HTTP_MIME_WEBM      "video/webm"


//

// Useful headers

//

#define HTTP_ACCEPT_JSON_HEADER "application/json, */*"


//

// HTTP Routes

//

#define NET_HTTP_API_ROUTE "/api/"


//

// Mime Ext Defines

//

#define HTTP_MIME_JSON_EXT      ".json"

#define HTTP_MIME_XML_EXT       ".xml"

#define HTTP_MIME_TEXT_EXT      ".txt"

#define HTTP_MIME_HTML_EXT      ".html"

#define HTTP_MIME_JS_EXT        ".js"

#define HTTP_MIME_CSS_EXT       ".css"

#define HTTP_MIME_MP4_EXT       ".mp4"

#define HTTP_MIME_MP3_EXT       ".mp3"

#define HTTP_MIME_OGGM_EXT      ".ogm"

#define HTTP_MIME_OGGV_EXT      ".ogv"

#define HTTP_MIME_OGG_EXT       ".ogg"

#define HTTP_MIME_WEBM_EXT      ".webm"


//

// HTTP Request Defines

//

#define HTTP_CONTENT_LENGTH     "Content-Length"

#define HTTP_CONTENT_TYPE       "Content-Type"

#define HTTP_REQ_COOKIE         "Cookie"

#define HTTP_ORIGIN             "Origin"

#define HTTP_ACR_METHOD         "Access-Control-Request-Method"

#define HTTP_ACR_METHODS        "Access-Control-Request-Methods"

#define HTTP_ACR_HEADERS        "Access-Control-Request-Headers"

#define HTTP_AUTHORIZATION      "Authorization"

#define HTTP_ACCEPT             "Accept"

#define HTTP_USER_AGENT         "User-Agent"

#define HTTP_X_FORWARDED_FOR    "X-Forwarded-For"

#define HTTP_HOST               "Host"

#define HTTP_EXPECT             "Expect"

#define HTTP_ACCEPT_ENCODING    "Accept-Encoding"

#define HTTP_CONNECTION         "Connection"

#define HTTP_UPGRADE            "Upgrade"

#define HTTP_WEBSOCKET          "websocket"

#define HTTP_TRANSFER_ENCODING  "Transfer-Encoding"

#define HTTP_CONTENT_DISP       "Content-Disposition"

#define HTTP_RANGE              "Range"

// Web socket specific

#define HTTP_WEBSOCKET_KEY      "Sec-WebSocket-Key"

#define HTTP_WEBSOCKET_PROTOCOL "Sec-WebSocket-Protocol"

#define HTTP_WEBSOCKET_VERSION  "Sec-WebSocket-Version"

#define HTTP_WEBSOCKET_Extensions "Sec-WebSocket-Extensions"


//

// HTTP Response Defines

//

#define HTTP_SET_COOKIE         "Set-Cookie"

#define HTTP_ACAO               "Access-Control-Allow-Origin"

#define HTTP_ACAO_METHODS       "Access-Control-Allow-Methods"

#define HTTP_ACAO_HEADERS       "Access-Control-Allow-Headers"

#define HTTP_SERVER             "Server"

#define HTTP_ALLOW              "Allow"

#define HTTP_DATE               "Date"

#define HTTP_LAST_MODIFIED      "Last-Modified"

#define HTTP_KEEP_ALIVE         "Keep-Alive"

#define HTTP_CONNECTION         "Connection"

#define HTTP_CONTENT_ENCODING   "Content-Encoding"

#define HTTP_ETAG               "ETag"

#define HTTP_CONTENT_RANGE      "Content-Range"

#define HTTP_ACCEPT_RANGES      "Accept-Ranges"

#define HTTP_AGE                "Age"

#define HTTP_CACHE_CONTROL      "Cache-Control"

#define HTTP_EXPIRES            "Expires"

#define HTTP_STRICT_TS          "Strict-Transport-Security"

#define HTTP_VARY               "Vary"

#define HTTP_WWW_AUTHENTICATE   "WWW-Authenticate"

#define HTTP_LOCATION           "Location"

// Web socket specific

#define HTTP_WEBSOCKET_ACCEPT   "Sec-WebSocket-Accept"


//

// HTTP Response Code Messages

//

#define HTTP_100_CODE "Continue"

#define HTTP_101_CODE "Switching Protocols"


#define HTTP_200_CODE "Ok"

#define HTTP_201_CODE "Created"

#define HTTP_202_CODE "Accepted"

#define HTTP_203_CODE "Non-Authoritative Information"

#define HTTP_204_CODE "No Content"

#define HTTP_205_CODE "Reset Content"

#define HTTP_206_CODE "Partial Content"


#define HTTP_300_CODE "Multiple Choices"

#define HTTP_301_CODE "Moved Permanently"

#define HTTP_302_CODE "Found"

#define HTTP_303_CODE "See Other"

#define HTTP_304_CODE "Not Modified"

#define HTTP_307_CODE "Temporary Redirect"

#define HTTP_308_CODE "Permanent Redirect"


#define HTTP_400_CODE "Bad Request"

#define HTTP_401_CODE "Unauthorized"

#define HTTP_402_CODE "Payment Required"

#define HTTP_403_CODE "Forbidden"

#define HTTP_404_CODE "Not Found"

#define HTTP_405_CODE "Method Not Allowed"

#define HTTP_406_CODE "Not Acceptable"

#define HTTP_407_CODE "Proxy Authentication"

#define HTTP_408_CODE "Request Timeout"

#define HTTP_409_CODE "Conflict"

#define HTTP_410_CODE "Gone"

#define HTTP_411_CODE "Length Required"

#define HTTP_412_CODE "Precondition Failed"

#define HTTP_413_CODE "Request Entity Too Large"

#define HTTP_414_CODE "Request-URI Too Long"

#define HTTP_415_CODE "Unsupported Media Type"

#define HTTP_416_CODE "Requested Range Not Satisfiable"

#define HTTP_417_CODE "Expectation Failed"

#define HTTP_422_CODE "Unprocessable Entity"

#define HTTP_425_CODE "Too Early"

#define HTTP_426_CODE "Upgrade Required"

#define HTTP_428_CODE "Precondition Required"

#define HTTP_429_CODE "Too Many Requests"

#define HTTP_431_CODE "Request Header Fields Too Large"

#define HTTP_451_CODE "Unavailable For Legal Reasons"


#define HTTP_500_CODE "Internal Server Error"

#define HTTP_501_CODE "Not Implemented"

#define HTTP_502_CODE "Bad Gateway"

#define HTTP_503_CODE "Service Unavailable"

#define HTTP_504_CODE "Gateway Timeout"

#define HTTP_505_CODE "HTTP Version Not Supported"

#define HTTP_511_CODE "Network Authentication Required"


//

// HTTP Stock Replies

//

#define HTTP_200_CODE_MSG "Request Successful."


#define HTTP_400_CODE_MSG "Server was unable to understand the clients request."

#define HTTP_401_CODE_MSG "Client is not authorized to execute the request."

#define HTTP_403_CODE_MSG "You are forbidden to execute the request."

#define HTTP_404_CODE_MSG "Unable to process the requested resouce."

#define HTTP_408_CODE_MSG "Request has timed out."

#define HTTP_413_CODE_MSG "Payload was to large to be able to process."

#define HTTP_415_CODE_MSG "Provided media type is not currently supported."


#define HTTP_500_CODE_MSG "Something has gone wrong internally in the server."

#define HTTP_501_CODE_MSG "Request has not been implemented."

#define HTTP_505_CODE_MSG "HTTP Version is not currently supported."


//

// API command and parameter names

//

#define NET_API_INFO_CMD "cmd_api_info"


#define NET_API_VERSION_NAME "api_version"

#define NET_INC_FUNC_NAME "inc_func"

#define NET_FUNCS_NAME "functions"

#define NET_CLIENT_VERSION_NAME "client_version"


#endif // __NET_HTTPDefines_H__