Http::NebulaHttpClient Class Reference

#include <nebulahttpclient.h>

Inherits Core::RefCounted.

Inherited by Http::HttpClient.

Public Member Functions
	NebulaHttpClient ()
	constructor
virtual	~NebulaHttpClient ()
	destructor
void	SetUserAgent (const Util::String &userAgent)
	set the user-agent to use for HTTP requests
const Util::String &	GetUserAgent () const
	get the user-agent
bool	Connect (const IO::URI &uri)
	establish a connection to a HTTP server
void	Disconnect ()
	disconnect from the server
bool	IsConnected () const
	return true if currently connected
HttpStatus::Code	SendRequest (HttpMethod::Code requestMethod, const IO::URI &uri, const Ptr< IO::Stream > &responseContentStream)
	send request and write result to provided response content stream
HttpStatus::Code	SendRequest (HttpMethod::Code requestMethod, const IO::URI &uri, const Util::String &body, const Ptr< IO::Stream > &responseContentStream)
	send request with body and write result to provided response content stream
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 (NebulaHttpClient)

Private Attributes
Util::String	userAgent
Ptr< Net::TcpClient >	tcpClient

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)

Constructor & Destructor Documentation

NebulaHttpClient()

Http::NebulaHttpClient::NebulaHttpClient

(

)

constructor

~NebulaHttpClient()

Http::NebulaHttpClient::~NebulaHttpClient ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Http::NebulaHttpClient::__DeclareClass ( NebulaHttpClient )

private

Connect()

bool Http::NebulaHttpClient::Connect

(

const IO::URI &

uri

)

establish a connection to a HTTP server

Disconnect()

void Http::NebulaHttpClient::Disconnect

(

)

disconnect from the server

GetUserAgent()

const Util::String & Http::NebulaHttpClient::GetUserAgent ( ) const

inline

get the user-agent

IsConnected()

bool Http::NebulaHttpClient::IsConnected

(

)

const

return true if currently connected

SendRequest() [1/2]

HttpStatus::Code Http::NebulaHttpClient::SendRequest	(	HttpMethod::Code	requestMethod,
		const IO::URI &	uri,
		const Ptr< IO::Stream > &	responseContentStream )

send request and write result to provided response content stream

SendRequest() [2/2]

HttpStatus::Code Http::NebulaHttpClient::SendRequest	(	HttpMethod::Code	requestMethod,
		const IO::URI &	uri,
		const Util::String &	body,
		const Ptr< IO::Stream > &	responseContentStream )

send request with body and write result to provided response content stream

SetUserAgent()

void Http::NebulaHttpClient::SetUserAgent ( const Util::String & userAgent )

inline

set the user-agent to use for HTTP requests

Member Data Documentation

tcpClient

Ptr<Net::TcpClient> Http::NebulaHttpClient::tcpClient

private

userAgent

Util::String Http::NebulaHttpClient::userAgent

private

---

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

• /github/workspace/code/foundation/http/simple/nebulahttpclient.h
• /github/workspace/code/foundation/http/simple/nebulahttpclient.cc