MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
Public Member Functions | List of all members
HttpRequest Class Referenceabstract

Interface that describes a single HTTP request. More...

#include <mip/http_request.h>

Public Member Functions

virtual const std::string & GetId () const =0
 Gets request ID.
 
virtual HttpRequestType GetRequestType () const =0
 Get request type.
 
virtual const std::string & GetUrl () const =0
 Get request url.
 
virtual const std::vector< uint8_t > & GetBody () const =0
 Get request body.
 
virtual const std::map< std::string, std::string, CaseInsensitiveComparator > & GetHeaders () const =0
 Get request headers.
 
virtual TransportLayerSecurityMinimumVersion GetTransportLayerSecurityMinimumVersion () const =0
 Get the minimum required TLS version for this request.
 
virtual ~HttpRequest ()
 

Detailed Description

Interface that describes a single HTTP request.

Constructor & Destructor Documentation

◆ ~HttpRequest()

virtual HttpRequest::~HttpRequest ( )
inlinevirtual

Member Function Documentation

◆ GetBody()

virtual const std::vector< uint8_t > & HttpRequest::GetBody ( ) const
pure virtual

Get request body.

Returns
Request body

◆ GetHeaders()

virtual const std::map< std::string, std::string, CaseInsensitiveComparator > & HttpRequest::GetHeaders ( ) const
pure virtual

Get request headers.

Returns
Request headers

◆ GetId()

virtual const std::string & HttpRequest::GetId ( ) const
pure virtual

Gets request ID.

Returns
Request ID
Note
The corresponding HttpResponse will have the same ID

◆ GetRequestType()

virtual HttpRequestType HttpRequest::GetRequestType ( ) const
pure virtual

Get request type.

Returns
Request type

◆ GetTransportLayerSecurityMinimumVersion()

virtual TransportLayerSecurityMinimumVersion HttpRequest::GetTransportLayerSecurityMinimumVersion ( ) const
pure virtual

Get the minimum required TLS version for this request.

Returns
The minimum required TLS version the Http transport provider should be secured with.

◆ GetUrl()

virtual const std::string & HttpRequest::GetUrl ( ) const
pure virtual

Get request url.

Returns
Request url
The documentation for this class was generated from the following file: