HttpMessageGenerator Class Reference

HTTP message generator. More...

#include <cc/HttpMessageGenerator>

Inheritance diagram for HttpMessageGenerator:

Public Member Functions
	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.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
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.

Protected Member Functions
	HttpMessageGenerator (State *newState)
State &	me ()
const State &	me () const
Protected Member Functions inherited from Object
template<class T>
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)
Object &	operator= (std::nullptr_t)

Additional Inherited Members
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.
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< State >	me
	Internal object state

Detailed Description

HTTP message generator.

Constructor & Destructor Documentation

HttpMessageGenerator()

HttpMessageGenerator ( )

default

Create a null HTTP message generator.

Member Function Documentation

setHeader() [1/2]

void setHeader	(	const String &	name,
		const String &	value )

Set message header name to value

transmit() [1/3]

void transmit

(

)

Transmit HTTP message without payload.

transmit() [2/3]

void transmit

(

const String &

payload

)

Transmit HTTP message with attached payload.

transmit() [3/3]

void transmit

(

const Stream &

source

)

Transmit HTTP message and stream the payload from source.

setHeader() [2/2]

void setHeader

(

const Map< String, String > &

header

)

Set a custom message header

beginTransmission()

void beginTransmission

(

long long

contentLength = -1

)

Begin message transmission.

payload()

Stream payload

(

)

Get access to the payload stream.

write()

void write

(

const Bytes &

data

)

Write data to the payload stream.

chunk() [1/2]

Format chunk

(

const String &

pattern

)

Create a new payload chunk with given format pattern.

chunk() [2/2]

Format chunk

(

)

Create a new payload chunk.

endTransmission()

void endTransmission

(

)

End of message transmission.