LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::HttpRequest Class Referencefinal

An HTTP request. More...

#include <luciad/net/http/HttpRequest.h>

Classes

class  Builder
 A builder of luciad::HttpRequests. More...
 

Public Member Functions

 HttpRequest (const HttpRequest &other)
 
 HttpRequest (HttpRequest &&other) noexcept
 
 ~HttpRequest ()
 
Builder asBuilder () const
 Returns an HttpRequest builder that has all properties of this HttpRequest. More...
 
std::string getBaseUri () const
 Returns the request's URI without the query string. More...
 
const std::optional< DataEntity > & getBody () const
 Returns the body for this http request, if any. More...
 
const std::vector< HttpHeader > & getHeaders () const
 Returns the request headers for this request. More...
 
HttpRequestMethod getMethod () const
 Returns the request method for this request. More...
 
const std::vector< UriQueryParameter > & getQueryParameters () const
 Returns the query parameters for this request. More...
 
std::string getUri () const
 Returns the request's URI. More...
 
HttpRequestoperator= (HttpRequest other) noexcept
 

Static Public Member Functions

static Builder newBuilder ()
 Creates a new HttpRequest builder. More...
 

Detailed Description

An HTTP request.

An HttpRequest instance is built through an luciad::HttpRequest::Builder.

Since
2023.0

Constructor & Destructor Documentation

◆ HttpRequest() [1/2]

luciad::HttpRequest::HttpRequest ( const HttpRequest other)

◆ HttpRequest() [2/2]

luciad::HttpRequest::HttpRequest ( HttpRequest &&  other)
noexcept

◆ ~HttpRequest()

luciad::HttpRequest::~HttpRequest ( )

Member Function Documentation

◆ asBuilder()

Builder luciad::HttpRequest::asBuilder ( ) const

Returns an HttpRequest builder that has all properties of this HttpRequest.

Returns
an HttpRequest builder that has all properties of this HttpRequest.

◆ getBaseUri()

std::string luciad::HttpRequest::getBaseUri ( ) const

Returns the request's URI without the query string.

Returns
the request's URI without the query string.

◆ getBody()

const std::optional< DataEntity > & luciad::HttpRequest::getBody ( ) const

Returns the body for this http request, if any.

Returns
the body for this http request, if any.

◆ getHeaders()

const std::vector< HttpHeader > & luciad::HttpRequest::getHeaders ( ) const

Returns the request headers for this request.

Returns
the request headers for this request.

◆ getMethod()

HttpRequestMethod luciad::HttpRequest::getMethod ( ) const

Returns the request method for this request.

Returns
the request method for this request.

◆ getQueryParameters()

const std::vector< UriQueryParameter > & luciad::HttpRequest::getQueryParameters ( ) const

Returns the query parameters for this request.

Returns
the query parameters for this request.

◆ getUri()

std::string luciad::HttpRequest::getUri ( ) const

Returns the request's URI.

Returns
the request's URI.

◆ newBuilder()

static Builder luciad::HttpRequest::newBuilder ( )
static

Creates a new HttpRequest builder.

Returns
a new HttpRequest builder.

◆ operator=()

HttpRequest & luciad::HttpRequest::operator= ( HttpRequest  other)
noexcept