CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
HttpRequestGenerator Class Referencefinal

HTTP request generator. More...

#include <cc/HttpRequestGenerator>

Inheritance diagram for HttpRequestGenerator:

Public Member Functions

 HttpRequestGenerator (const Stream &stream)
 Create a new HTTP request generator for stream.
 
void setMethod (const String &method)
 Set the request method (either "GET", "HEAD", "PUT" or "POST")
 
void setPath (const String &path)
 Set the relative resource file path
 
void setVersion (const String &version)
 Set the protocol version (defaults to "HTTP/1.1")
 
void setHost (const String &host)
 Set the host header, equivalent to setHeader("Host", host)
 
- Public Member Functions inherited from HttpMessageGenerator
 HttpMessageGenerator ()=default
 Create a null HTTP message generator.
 
void setHeader (const String &name, const String &value)
 Set message header name to value
 
void transmit ()
 Transmit HTTP message without payload.
 
void transmit (const String &payload)
 Transmit HTTP message with attached payload.
 
void transmit (const Stream &source)
 Transmit HTTP message and stream the payload from source.
 
void setHeader (const Map< String, String > &header)
 Set a custom message header
 
void beginTransmission (long long contentLength=-1)
 Begin message transmission.
 
Stream payload ()
 Get access to the payload stream.
 
void write (const Bytes &data)
 Write data to the payload stream.
 
Format chunk (const String &pattern)
 Create a new payload chunk with given format pattern.
 
Format chunk ()
 Create a new payload chunk.
 
void endTransmission ()
 End of message transmission.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
long useCount () const
 Reference count.
 

Additional Inherited Members

- Protected Member Functions inherited from HttpMessageGenerator
 HttpMessageGenerator (State *newState)
 
State & me ()
 
const State & me () const
 
- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 
- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

HTTP request generator.

Constructor & Destructor Documentation

◆ HttpRequestGenerator()

HttpRequestGenerator ( const Stream & stream)

Create a new HTTP request generator for stream.

Member Function Documentation

◆ setMethod()

void setMethod ( const String & method)

Set the request method (either "GET", "HEAD", "PUT" or "POST")

◆ setPath()

void setPath ( const String & path)

Set the relative resource file path

◆ setVersion()

void setVersion ( const String & version)

Set the protocol version (defaults to "HTTP/1.1")

◆ setHost()

void setHost ( const String & host)

Set the host header, equivalent to setHeader("Host", host)