http_response.h

Go to the documentation of this file.

/*!**********************************************************************
 *
 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
 *            All rights reserved.
 *
 *************************************************************************
 *
 * @file     http_response.h
 * @date     Jul 19, 2016
 * @brief    HTTP response module header file.
 *
 * This module analyzes and parses received HTTP response messages.
 *
 ************************************************************************/

#ifndef HTTP_RESPONSE_H_
#define HTTP_RESPONSE_H_

#include "string_array.h"

typedef enum E_MCL_HTTP_RESULT_CODE
{
    MCL_HTTP_RESULT_CODE_UNKNOWN = 0,                     
    MCL_HTTP_RESULT_CODE_GENERAL_INFORMATION_1XX = 1,     
    MCL_HTTP_RESULT_CODE_CONTINUE = 100,                  
    MCL_HTTP_RESULT_CODE_GENERAL_SUCCESSFUL_2XX = 2,      
    MCL_HTTP_RESULT_CODE_SUCCESS = 200,                   
    MCL_HTTP_RESULT_CODE_CREATED = 201,                   
    MCL_HTTP_RESULT_CODE_PARTIAL_CONTENT = 206,           
    MCL_HTTP_RESULT_CODE_GENERAL_REDIRECTION_3XX = 3,     
    MCL_HTTP_RESULT_CODE_MOVED_PERMANENTLY = 301,         
    MCL_HTTP_RESULT_CODE_USE_PROXY = 305,                 
    MCL_HTTP_RESULT_CODE_GENERAL_CLIENT_ERROR_4XX = 4,    
    MCL_HTTP_RESULT_CODE_BAD_REQUEST = 400,               
    MCL_HTTP_RESULT_CODE_UNAUTHORIZED = 401,              
    MCL_HTTP_RESULT_CODE_FORBIDDEN = 403,                 
    MCL_HTTP_RESULT_CODE_NOT_FOUND = 404,                 
    MCL_HTTP_RESULT_CODE_METHOD_NOT_ALLOWED = 405,        
    MCL_HTTP_RESULT_CODE_PROXY_AUTH_REQUIRED = 407,       
    MCL_HTTP_RESULT_CODE_REQUEST_TIMEOUT = 408,           
    MCL_HTTP_RESULT_CODE_CONFLICT = 409,                  
    MCL_HTTP_RESULT_CODE_PRECONDITION_FAILED = 412,       
    MCL_HTTP_RESULT_CODE_PAYLOAD_TOO_LARGE = 413,         
    MCL_HTTP_RESULT_CODE_TOO_MANY_REQUESTS = 429,         
    MCL_HTTP_RESULT_CODE_GENERAL_SERVER_ERROR_5XX = 5,    
    MCL_HTTP_RESULT_CODE_INTERNAL_SERVER_ERR = 500,       
    MCL_HTTP_RESULT_CODE_NOT_IMPLEMENTED = 501,           
    MCL_HTTP_RESULT_CODE_BAD_GATEWAY = 502,               
    MCL_HTTP_RESULT_CODE_SERVICE_UNAVAILABLE = 503,       
    MCL_HTTP_RESULT_CODE_GATEWAY_TIMEOUT = 504,           
    MCL_HTTP_RESULT_CODE_HTTP_VERSION_NOT_SUPPORTED = 505 
} E_MCL_HTTP_RESULT_CODE;

typedef struct http_response_t
{
    string_array_t *header;             
    mcl_uint8_t *payload;               
    mcl_size_t payload_size;            
    E_MCL_HTTP_RESULT_CODE result_code; 
} http_response_t;

E_MCL_ERROR_CODE http_response_initialize(string_array_t *header, mcl_uint8_t *payload, mcl_size_t payload_size, E_MCL_HTTP_RESULT_CODE result_code, http_response_t **http_response);

E_MCL_ERROR_CODE http_response_get_header(http_response_t *http_response, char *header_name, string_t **header_value);

mcl_uint8_t *http_response_get_payload(http_response_t *http_response);

E_MCL_HTTP_RESULT_CODE http_response_get_result_code(http_response_t *http_response);

void http_response_destroy(http_response_t **http_response);

#endif //HTTP_RESPONSE_H_