Http::HttpResponseWriter Class Reference

#include <httpresponsewriter.h>

Detailed Description

Stream writer which writes a correct HTTP response to a stream.

Copyright

(C) 2007 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits IO::StreamWriter.

Public Member Functions
void	SetStatusCode (HttpStatus::Code statusCode)
	set status code
void	SetContent (const Ptr< IO::Stream > &contentStream)
	set optional content stream (needs valid media type!)
void	WriteResponse ()
	write http response to the stream
Public Member Functions inherited from IO::StreamWriter
	StreamWriter ()
	constructor
virtual	~StreamWriter ()
	destructor
void	SetStream (const Ptr< Stream > &s)
	set stream to write to
const Ptr< Stream > &	GetStream () const
	get currently set stream
bool	HasStream () const
	return true if a stream is set
virtual bool	Open ()
	begin reading from the stream
virtual void	Close ()
	end reading from the stream
bool	IsOpen () const
	return true if currently open
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (HttpResponseWriter)

Private Attributes
HttpStatus::Code	statusCode
Ptr< IO::Stream >	contentStream

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)
Protected Attributes inherited from IO::StreamWriter
Ptr< Stream >	stream
bool	isOpen
bool	streamWasOpen

Member Function Documentation

__DeclareClass()

Http::HttpResponseWriter::__DeclareClass ( HttpResponseWriter )

private

SetContent()

void Http::HttpResponseWriter::SetContent ( const Ptr< IO::Stream > & contentStream )

inline

set optional content stream (needs valid media type!)

SetStatusCode()

void Http::HttpResponseWriter::SetStatusCode ( HttpStatus::Code statusCode )

inline

set status code

WriteResponse()

void Http::HttpResponseWriter::WriteResponse

(

)

write http response to the stream

Member Data Documentation

contentStream

Ptr<IO::Stream> Http::HttpResponseWriter::contentStream

private

statusCode

HttpStatus::Code Http::HttpResponseWriter::statusCode

private

---

The documentation for this class was generated from the following files:

• /github/workspace/code/foundation/http/httpresponsewriter.h
• /github/workspace/code/foundation/http/httpresponsewriter.cc