Skip to content

Latest commit

 

History

History
264 lines (208 loc) · 7.71 KB

request.md

File metadata and controls

264 lines (208 loc) · 7.71 KB
Raw

HTTP请求处理

数据结构

请求方法

定义一个请求方法的映射数组，通过 http_request_method_t 可索引。

typedef enum http_request_method {
    HTTP_REQUEST_METHOD_INVALID      =   0x00,
    HTTP_REQUEST_METHOD_GET          =   0x01,       /* http GET method, http/1.0 */
    HTTP_REQUEST_METHOD_POST         =   0x02,       /* http POST method, http/1.0 */
    HTTP_REQUEST_METHOD_HEAD         =   0x03,       /* http HEAD method, http/1.0 */
    HTTP_REQUEST_METHOD_PUT          =   0x04,       /* http PUT method, http/1.1 */
    HTTP_REQUEST_METHOD_DELETE       =   0x05,       /* http DELETE method, http/1.1 */
    HTTP_REQUEST_METHOD_OPTIONS      =   0x06,       /* http OPTIONS method, http/1.1 */
    HTTP_REQUEST_METHOD_TRACE        =   0x07,       /* http TRACE method, http/1.1 */
    HTTP_REQUEST_METHOD_CONNECT      =   0x08,       /* http CONNECT method, http/1.1, reserved */
    HTTP_REQUEST_METHOD_PATCH        =   0x09        /* http PATCH method, echo test */
} http_request_method_t;
static const char *HTTP_METHOD_MAPPING[] = {"INVALID ", "GET ", "POST ", "HEAD ", "PUT ", "DELETE ", "OPTIONS ", "TRACE ", "CONNECT ", "PATCH " };

请求报文头部

参考HTTP RFC。

typedef enum http_request_header {
    HTTP_REQUEST_HEADER_INVALID = 0x00,
    HTTP_REQUEST_HEADER_CACHE_CONTROL,
    HTTP_REQUEST_HEADER_CONNECTION,
    HTTP_REQUEST_HEADER_DATE,
    HTTP_REQUEST_HEADER_PRAGMA,
    HTTP_REQUEST_HEADER_TRAILER,
    HTTP_REQUEST_HEADER_TRANSFER_ENCODING,
    HTTP_REQUEST_HEADER_UPGRADE,
    HTTP_REQUEST_HEADER_VIA,
    HTTP_REQUEST_HEADER_WARNING,
    HTTP_REQUEST_HEADER_ACCEPT,
    HTTP_REQUEST_HEADER_ACCEPT_CHARSET,
    HTTP_REQUEST_HEADER_ACCEPT_ENCODING,
    HTTP_REQUEST_HEADER_ACCEPT_LANGUAGE,
    HTTP_REQUEST_HEADER_AUTHORIZATION,
    HTTP_REQUEST_HEADER_EXPECT,
    HTTP_REQUEST_HEADER_FROM,
    HTTP_REQUEST_HEADER_HOST,
    HTTP_REQUEST_HEADER_IF_MATCH,
    HTTP_REQUEST_HEADER_IF_MODIFIED_SINCE,
    HTTP_REQUEST_HEADER_IF_NONE_MATCH,
    HTTP_REQUEST_HEADER_IF_RANGE,
    HTTP_REQUEST_HEADER_IF_UNMODIFIED_SINCE,
    HTTP_REQUEST_HEADER_MAX_FORWARDS,
    HTTP_REQUEST_HEADER_PROXY_AUTHORIZATION,
    HTTP_REQUEST_HEADER_RANGE,
    HTTP_REQUEST_HEADER_REFERER,
    HTTP_REQUEST_HEADER_TE,
    HTTP_REQUEST_HEADER_USER_AGENT,
    HTTP_REQUEST_HEADER_ALLOW,
    HTTP_REQUEST_HEADER_CONTENT_LENGTH,
    HTTP_REQUEST_HEADER_CONTENT_TYPE
} http_request_header_t;

头部映射数组：

static const char *HTTP_REQUEST_HEADERS_MAPPING[] = {
    "INVALID",
    "Cache-Control: ",
    "Connection: ",
    "Date: ",
    "Pragma: ",
    "Trailer: ",
    "Transfer-Encoding: ",
    "Upgrade: ",
    "Via: ",
    "Warning: ",
    "Accept: ",
    "Accept-Charset: ",
    "Accept-Encoding: ",
    "Accept-Language: ",
    "Authorization: ",
    "Expect: ",
    "From: ",
    "Host: ",
    "If-Match: ",
    "If-Modified-Since: ",
    "If-None-Match: ",
    "If-Range: ",
    "If-Unmodified-Since: ",
    "Max-Forwards: ",
    "Proxy-Authorization: ",
    "Range: ",
    "Referer: ",
    "TE: ",
    "User-Agent: ",
    "Allow: ",
    "Content-Length: ",
    "Content-Type: "
};

请求报文

包括起始行、头部、主体，均采用http_message_buffer_t描述。

typedef struct http_request_message {
    http_message_buffer_t           *line;  
    http_message_buffer_t           *header;
    http_message_buffer_t           *body;
} http_request_message_t;

请求

包括请求方法、请求报文、标志等。

typedef struct http_request {
    http_request_method_t           method;
    http_request_message_t          req_msg;
    uint32_t                        header_index;
    union {
        uint32_t                    flag;
        struct {
            uint32_t no_keep_alive  : 8;
            uint32_t no_is_http11   : 8;
            uint32_t othre          : 16;
        } flag_t;
    } req_flag;
} http_request_t;

外部函数

  • http 请求初始化，主要是为请求报文分配内存空间，比如请求起始行、首部字段、主体字段，调用的是 http_message_buffer_init() 函数。

    int http_request_init(http_request_t *req)

  • http 请求结构释放，因为在初始化时通过 http_message_buffer_init() 函数动态分配了内存空间，此时要释放它。

    int http_request_release(http_request_t *req);

  • http 请求报文头部字段初始化，设置请求头部索引 header_index 的值为 0，主要填充默认的头部字段，比如默认的长连接 Connection: Keep-Alive，接受的数据类型 Accept: */* 等。

    int http_request_header_init(http_request_t *req)

  • 设置 HTTP 协议版本、请求方法、指定为非长连接等

    int http_request_set_version(http_request_t *req, const char *str)
    int http_request_set_method(http_request_t *req,  http_request_method_t method)
    int http_request_no_keep_alive(http_request_t *req)

  • 构造请求起始行，传入请求的方法、路径。

    int http_request_start_line(http_request_t *req,  http_request_method_t method, const char *path)

  • 构造请求起始行，传入请求的方法、路径、查询参数等。

    int http_request_set_start_line_with_query(http_request_t *req, const char *path, const char *query)

  • 添加请求头部的内容，指定 key: value，key 字段内容可参考HTTP RFC，也可参考 HTTP_REQUEST_HEADERS_MAPPING 数组的内容。

    void http_request_add_header(http_request_t *req, const char *key, const char *value)

  • 通过索引的方式添加请求头部的 value 字段，如果存在则不会添加。

    void http_request_add_header_form_index(http_request_t *req, http_request_header_t header, const char *value)

  • 通过 key 或者 索引 获取头部字段的内容

    char *http_request_get_header(http_request_t *req, const char *key)
    char *http_request_get_header_form_index(http_request_t *req, http_request_header_t index)

  • 设置请求报文的主体部分，此操作会填充请求头部的 Content-Length:` 字段。

    int http_request_set_body(http_request_t *req, const char *buf, size_t size)

  • 通过指针引用的方式设置报文主体部分，此操作是为了避免占用太大的内存消耗，而且会填充请求头部的 Content-Length: 字段。

    int http_request_set_body_form_pointer(http_request_t *req, const char *buf, size_t size)

  • 获取请求报文各个字段的数据，起始行、首部、主体。

    char *http_request_get_start_line_data(http_request_t *req)
    char *http_request_get_header_data(http_request_t *req)
    char *http_request_get_body_data(http_request_t *req)

  • 获取请求报文各个字段的数据，起始行、首部、主体的长度。

    size_t http_request_get_start_line_length(http_request_t *req)
    size_t http_request_get_header_length(http_request_t *req)
    size_t http_request_get_body_length(http_request_t *req)

  • 打印请求报文各个字段的数据，起始行、首部、主体。

    char *http_request_print_start_line(http_request_t *req)
    char *http_request_print_header(http_request_t *req)
    char *http_request_print_body(http_request_t *req)

上一篇：HTTP 报文处理

下一篇：HTTP 响应