http_request.h

Go to the documentation of this file.

/*!**********************************************************************
 *
 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
 *            All rights reserved.
 *
 *************************************************************************
 *
 * @file     http_request.h
 * @date     Jun 28, 2016
 * @brief    HTTP request module header file.
 *
 * HTTP request messages are built with this module. It has the abilities like adding headers and adding boundaries
 * automatically when inserting a single or tuple. Manages the multipart/mixed message structure.
 *
 ************************************************************************/

#ifndef HTTP_REQUEST_H_
#define HTTP_REQUEST_H_

#include "http_definitions.h"
#include "string_array.h"

// "--".
#define BOUNDARY_SIGN_LENGTH 2
#define BOUNDARY_SIGN "--"

// ": ".
#define COLON_FORMAT_LENGTH 2

// When boundary length is changed, test should be updated with the new length. Otherwise length test fails.
#define BOUNDARY_LENGTH 22
#define BOUNDARY_CHARACTER_COUNT 62

#define GROWTH_FACTOR 1.5

// Length of the string "Content-Type: multipart/related;boundary=5c6d7e29ef6868d0eb73ck" + "\r\n".
#define CONTENT_TYPE_LINE_LENGTH  65

// Length of the string "Content-Type: "
#define CONTENT_TYPE_HEADER_LENGTH 14

// Length of the string "Content-ID: "
#define CONTENT_ID_HEADER_LENGTH 12

// Length of "\r\n".
#define NEW_LINE_LENGTH 2
#define NEW_LINE    "\r\n"

// Both opening and closing boundary line lengths are equal to boundary_line_length.
// opening_boundary = \r\n--5c6d7e29ef6868d0eb73\r\n , closing_boundary = \r\n--5c6d7e29ef6868d0eb73--
#define BOUNDARY_LINE_LENGTH (BOUNDARY_SIGN_LENGTH + BOUNDARY_LENGTH + NEW_LINE_LENGTH)

// For http_request_initialize(), to state resizing of its buffer is enabled or not :
#define HTTP_REQUEST_RESIZE_ENABLED MCL_TRUE
#define HTTP_REQUEST_RESIZE_DISABLED MCL_FALSE

typedef enum E_MCL_HTTP_METHOD
{
    MCL_HTTP_GET,     
    MCL_HTTP_HEAD,    
    MCL_HTTP_POST,    
    MCL_HTTP_PUT,     
    MCL_HTTP_DELETE,  
    MCL_HTTP_CONNECT, 
    MCL_HTTP_OPTIONS, 
    MCL_HTTP_TRACE    
} E_MCL_HTTP_METHOD;

typedef struct http_request_t
{
    string_array_t *header;           
    mcl_uint8_t *payload;             
    mcl_size_t payload_size;          
    mcl_size_t payload_offset;        
    E_MCL_HTTP_METHOD method;         
    string_t *uri;                    
    string_t *boundary;               
    mcl_size_t max_http_payload_size; 
    mcl_bool_t resize_enabled;        
    mcl_bool_t finalized;             
} http_request_t;

typedef mcl_size_t (*payload_copy_callback_t)(void *destination, void *source, mcl_size_t size, void *user_context);

E_MCL_ERROR_CODE http_request_initialize(E_MCL_HTTP_METHOD method, string_t *uri, mcl_size_t header_size, mcl_size_t payload_size, mcl_bool_t resize_enabled,
        string_t *user_agent, mcl_size_t max_http_payload_size, http_request_t **http_request);

E_MCL_ERROR_CODE http_request_add_header(http_request_t *http_request, string_t *header_name, string_t *header_value);

E_MCL_ERROR_CODE http_request_add_single(http_request_t *http_request, string_t *content_type, string_t *content_id, string_t *meta_string);

E_MCL_ERROR_CODE http_request_add_tuple(http_request_t *http_request, string_t *meta, string_t *meta_content_type, payload_copy_callback_t payload_copy_callback,
        void *user_context, void *payload, mcl_size_t payload_size, string_t *payload_content_type);

E_MCL_ERROR_CODE http_request_start_tuple(http_request_t *http_request);

E_MCL_ERROR_CODE http_request_start_tuple_sub_section(http_request_t *http_request, string_t *content_type, string_t *content_id, string_t **sub_boundary);

E_MCL_ERROR_CODE http_request_end_tuple_sub_section(http_request_t *http_request, string_t *sub_boundary);

E_MCL_ERROR_CODE http_request_add_raw_data(http_request_t *http_request, payload_copy_callback_t copy_callback, void *user_context, void *data, mcl_size_t data_size,
        mcl_size_t *actual_written_size);

mcl_size_t http_request_get_available_space_for_tuple(http_request_t *http_request);

mcl_size_t http_request_get_available_space_for_raw_data(http_request_t *http_request);

mcl_size_t http_request_get_available_space_for_single(http_request_t *http_request);

E_MCL_ERROR_CODE http_request_finalize(http_request_t *http_request);

void http_request_destroy(http_request_t **http_request);

#endif //HTTP_REQUEST_H_