Nebula
Loading...
Searching...
No Matches
Http::HttpRequestWriter Class Reference

#include <httprequestwriter.h>

Detailed Description

Writes a valid HTTP request header to a stream.

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

Inherits IO::StreamWriter.

Public Member Functions

 HttpRequestWriter ()
 constructor
void SetMethod (HttpMethod::Code httpMethod)
 set HTTP Method
void SetURI (const IO::URI &uri)
 set the URI of the request
void SetUserAgent (const Util::String &userAgent)
 set optional User-Agent string
bool WriteRequestHeader ()
 write the request header to the stream
bool WriteRequestHeaderWithBody (const Util::String &body)
 write a body
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 (HttpRequestWriter)

Private Attributes

HttpMethod::Code httpMethod
IO::URI uri
Util::String userAgent

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

Constructor & Destructor Documentation

◆ HttpRequestWriter()

Http::HttpRequestWriter::HttpRequestWriter ( )

constructor

Member Function Documentation

◆ __DeclareClass()

Http::HttpRequestWriter::__DeclareClass ( HttpRequestWriter )
private

◆ SetMethod()

void Http::HttpRequestWriter::SetMethod ( HttpMethod::Code httpMethod)
inline

set HTTP Method

◆ SetURI()

void Http::HttpRequestWriter::SetURI ( const IO::URI & uri)
inline

set the URI of the request

◆ SetUserAgent()

void Http::HttpRequestWriter::SetUserAgent ( const Util::String & userAgent)
inline

set optional User-Agent string

◆ WriteRequestHeader()

bool Http::HttpRequestWriter::WriteRequestHeader ( )

write the request header to the stream

◆ WriteRequestHeaderWithBody()

bool Http::HttpRequestWriter::WriteRequestHeaderWithBody ( const Util::String & body)

write a body

Member Data Documentation

◆ httpMethod

HttpMethod::Code Http::HttpRequestWriter::httpMethod
private

◆ uri

IO::URI Http::HttpRequestWriter::uri
private

◆ userAgent

Util::String Http::HttpRequestWriter::userAgent
private
The documentation for this class was generated from the following files: