httpreadwrite.hpp

Go to the documentation of this file.

#ifdef COMPA_HAVE_WEBSERVER
 
#ifndef COMPA_GENLIB_NET_HTTP_HTTPREADWRITE_HPP
#define COMPA_GENLIB_NET_HTTP_HTTPREADWRITE_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (c) 2012 France Telecom All rights reserved.
 * Copyright (C) 2022+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-06-12
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
// Last compare with ./pupnp source file on 2023-08-20, ver 1.14.17
#include <httpparser.hpp>
#include <sock.hpp>
 
#define HTTP_DEFAULT_TIMEOUT 30
 
#if defined(_WIN32) || defined(DOXYGEN_RUN)
tm* http_gmtime_r(const time_t* clock, tm* result);
#else
#define http_gmtime_r gmtime_r
#endif
 
int http_CancelHttpGet( //
    void* Handle        
);
 
int http_FixUrl(        //
    uri_type* url,      
    uri_type* fixed_url 
);
 
int http_FixStrUrl(     //
    const char* urlstr, 
    size_t urlstrlen,   
    uri_type* fixed_url 
);
 
SOCKET http_Connect(           //
    uri_type* destination_url, 
    uri_type* url              
);
 
int http_RecvMessage(             //
    SOCKINFO* info,               
    http_parser_t* parser,        
    http_method_t request_method, 
    int* timeout_secs,            
    int* http_error_code          
);
 
int http_SendMessage(SOCKINFO* info,  
                     int* TimeOut,    
                     const char* fmt, 
                     ... 
);
 
int http_RequestAndResponse(  //
    uri_type* destination,    
    const char* request,      
    size_t request_length,    
    http_method_t req_method, 
    int timeout_secs,         
    http_parser_t* response   
);
 
/************************************************************************
 * return codes:
 *      0 -- success
 *      UPNP_E_OUTOF_MEMORY
 *      UPNP_E_TIMEDOUT
 *      UPNP_E_BAD_REQUEST
 *      UPNP_E_BAD_RESPONSE
 *      UPNP_E_INVALID_URL
 *      UPNP_E_SOCKET_READ
 *      UPNP_E_SOCKET_WRITE
 ************************************************************************/
 
int http_Download(       //
    const char* url_str, 
    int timeout_secs,    
    char** document, 
    size_t* doc_length, 
    char* content_type  
);
 
int http_HttpGetProgress(
    void* Handle,   
    size_t* length, 
    size_t* total   
);
 
int http_OpenHttpConnection(
    const char* url_str,
    void** Handle,
    int timeout);
 
int http_MakeHttpRequest(
    Upnp_HttpMethod method,
    const char* url_str,
    void* Handle,
    UpnpString* headers,
    const char* contentType,
    int contentLength,
    int timeout);
 
int http_WriteHttpRequest(
    void* Handle,
    char* buf,
    size_t* size,
    int timeout);
 
int http_EndHttpRequest(
    void* Handle,
    int timeout);
 
int http_GetHttpResponse(
    void* Handle,
    UpnpString* headers,
    char** contentType,
    int* contentLength,
    int* httpStatus,
    int timeout);
 
int http_ReadHttpResponse(
    void* Handle,
    char* buf,
    size_t* size,
    int timeout);
 
int http_CloseHttpConnection(
    void* Handle);
 
int http_SendStatusResponse(
    SOCKINFO* info,       
    int http_status_code, 
    int request_major_version, 
    int request_minor_version  
);
 
// clang-format off
// clang-format on
int http_MakeMessage(
    membuffer* buf, 
    int http_major_version, 
    int http_minor_version, 
    const char* fmt,        
    ...                     
);
 
void http_CalcResponseVersion(
    int request_major_vers,   
    int request_minor_vers,   
    int* response_major_vers, 
    int* response_minor_vers  
);
 
int http_OpenHttpGetEx(
    const char* url_str, 
    void** Handle, 
    char** contentType, 
    int* contentLength, 
    int* httpStatus,    
    int lowRange,       
    int highRange,      
    int timeout         
);
 
void get_sdk_info(
    char* info,     
    size_t infoSize 
);
 
#endif /* COMPA_GENLIB_NET_HTTP_HTTPREADWRITE_HPP */
#endif // COMPA_HAVE_WEBSERVER