native_http_request.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares the parsed HTTP request record and request parsing helpers.
 */
 
#ifndef PHAROS_NATIVE_HTTP_REQUEST_H
#define PHAROS_NATIVE_HTTP_REQUEST_H
 
#include <stddef.h>
 
#include "native_connection.h"
 
/**
 * @brief Parsed HTTP request fields extracted from a native connection.
 */
typedef struct {
  char *method;         /**< Request method token such as GET or POST. */
  char *target;         /**< Raw request target path from the request line. */
  char *cookie;         /**< Cookie header value, if supplied. */
  char *content_type;   /**< Content-Type header value or the default form type. */
  char *headers;        /**< Normalized request headers joined with newlines. */
  char *body;           /**< Owned request body buffer when the request stays in memory. */
  char *body_file_path; /**< Temporary body file path when the request body is streamed to disk. */
  size_t body_len;      /**< Number of bytes stored in body or referenced by body_file_path. */
  int is_multipart;     /**< Non-zero when the request uses multipart form data. */
} HttpRequest;
 
/** @name HTTP request helpers
 * @{
 */
/**
 * @brief Parses an HTTP request from a native connection into a request record.
 * @param connection Connection supplying request bytes.
 * @param request Destination request record to populate.
 * @return 0 on success, or a non-zero native status code on parse or IO failure.
 */
int parse_http_request_native(NativeConnection *connection, HttpRequest *request);
/**
 * @brief Releases heap-owned fields in a parsed HTTP request record.
 * @param request Request record to clear.
 */
void free_http_request_native(HttpRequest *request);
 
 
/** @} */
#endif