clanNetwork Web

Classes
class	clan::HTTPRequestHandler
	HTTP request handler class. More...
class	clan::HTTPRequestHandlerProvider
	HTTP request handler provider interface. More...
class	clan::HTTPServer
	HTTP server. More...
class	clan::HTTPServerConnection
	HTTP server connection. More...

Construction
	clan::HTTPRequestHandler::HTTPRequestHandler ()
	Constructs a null instance. More...
	clan::HTTPRequestHandler::HTTPRequestHandler (HTTPRequestHandlerProvider *provider)
	Constructs a HTTPRequestHandler. More...
	clan::HTTPRequestHandler::~HTTPRequestHandler ()

Attributes
bool	clan::HTTPRequestHandler::is_null () const
	Returns true if this object is invalid. More...
void	clan::HTTPRequestHandler::throw_if_null () const
	Throw an exception if this object is invalid. More...
HTTPRequestHandlerProvider *	clan::HTTPRequestHandler::get_provider () const
	Get Provider. More...

Operations
bool	clan::HTTPRequestHandler::is_handling_request (const std::string &type, const std::string &url, const std::string &headers)
void	clan::HTTPRequestHandler::handle_request (HTTPServerConnection &connection)
	Handle request. More...

Construction
virtual	clan::HTTPRequestHandlerProvider::~HTTPRequestHandlerProvider ()

Operations
virtual bool	clan::HTTPRequestHandlerProvider::is_handling_request (const std::string &type, const std::string &url, const std::string &headers)=0
virtual void	clan::HTTPRequestHandlerProvider::handle_request (HTTPServerConnection &connection)=0
	Handle request. More...

Construction
	clan::HTTPServer::HTTPServer ()
	clan::HTTPServer::~HTTPServer ()

Operations
void	clan::HTTPServer::bind (const SocketName &name)
	Bind. More...
void	clan::HTTPServer::add_handler (const HTTPRequestHandler &handler)
	Add handler. More...
void	clan::HTTPServer::remove_handler (const HTTPRequestHandler &handler)
	Remove handler. More...

Construction
	clan::HTTPServerConnection::HTTPServerConnection ()
	Construct a null instance. More...
	clan::HTTPServerConnection::HTTPServerConnection (const std::shared_ptr< HTTPServerConnection_Impl > &impl)
	Constructs a HTTPServerConnection. More...
	clan::HTTPServerConnection::~HTTPServerConnection ()

Attributes
bool	clan::HTTPServerConnection::is_null () const
	Returns true if this object is invalid. More...
void	clan::HTTPServerConnection::throw_if_null () const
	Throw an exception if this object is invalid. More...
std::string	clan::HTTPServerConnection::get_request_type ()
	Get Request type. More...
std::string	clan::HTTPServerConnection::get_request_url ()
	Get Request url. More...
std::string	clan::HTTPServerConnection::get_request_headers ()
	Get Request headers. More...

Operations
DataBuffer	clan::HTTPServerConnection::read_request_data ()
	Read request data. More...
void	clan::HTTPServerConnection::write_response_status (int status_code, const std::string &status_text=std::string())
	Write response status. More...
void	clan::HTTPServerConnection::write_response_headers (const std::string &headers)
	Write response headers. More...
void	clan::HTTPServerConnection::write_response_data (const DataBuffer &data)
	Write response data. More...

Detailed Description

Function Documentation

clan::HTTPRequestHandler::HTTPRequestHandler

(

)

Constructs a null instance.

clan::HTTPRequestHandler::HTTPRequestHandler

(

HTTPRequestHandlerProvider *

provider

)

Constructs a HTTPRequestHandler.

Parameters

provider

= HTTPRequest Handler Provider

clan::HTTPServer::HTTPServer

(

)

clan::HTTPServerConnection::HTTPServerConnection

(

)

Construct a null instance.

clan::HTTPServerConnection::HTTPServerConnection

(

const std::shared_ptr< HTTPServerConnection_Impl > &

impl

)

Constructs a HTTPServerConnection.

Parameters

impl	= Shared Ptr

clan::HTTPRequestHandler::~HTTPRequestHandler

(

)

virtual clan::HTTPRequestHandlerProvider::~HTTPRequestHandlerProvider ( )

inlinevirtual

clan::HTTPServer::~HTTPServer

(

)

clan::HTTPServerConnection::~HTTPServerConnection

(

)

void clan::HTTPServer::add_handler

(

const HTTPRequestHandler &

handler

)

Add handler.

Parameters

handler

= HTTPRequest Handler

void clan::HTTPServer::bind

(

const SocketName &

name

)

Bind.

Parameters

name	= Socket Name

HTTPRequestHandlerProvider* clan::HTTPRequestHandler::get_provider

(

)

const

Get Provider.

Returns

provider

std::string clan::HTTPServerConnection::get_request_headers

(

)

Get Request headers.

Returns

request_headers

std::string clan::HTTPServerConnection::get_request_type

(

)

Get Request type.

Returns

request_type

std::string clan::HTTPServerConnection::get_request_url

(

)

Get Request url.

Returns

request_url

virtual void clan::HTTPRequestHandlerProvider::handle_request ( HTTPServerConnection &  connection )

pure virtual

Handle request.

Parameters

connection

= HTTPServer Connection

void clan::HTTPRequestHandler::handle_request

(

HTTPServerConnection &

connection

)

Handle request.

Parameters

connection

= HTTPServer Connection

virtual bool clan::HTTPRequestHandlerProvider::is_handling_request ( const std::string &  type, const std::string &  url, const std::string &  headers  )

pure virtual

bool clan::HTTPRequestHandler::is_handling_request	(	const std::string &	type,
		const std::string &	url,
		const std::string &	headers
	)

bool clan::HTTPRequestHandler::is_null ( ) const

inline

Returns true if this object is invalid.

bool clan::HTTPServerConnection::is_null ( ) const

inline

Returns true if this object is invalid.

DataBuffer clan::HTTPServerConnection::read_request_data

(

)

Read request data.

Returns

Data Buffer

void clan::HTTPServer::remove_handler

(

const HTTPRequestHandler &

handler

)

Remove handler.

Parameters

handler

= HTTPRequest Handler

void clan::HTTPRequestHandler::throw_if_null

(

)

const

Throw an exception if this object is invalid.

void clan::HTTPServerConnection::throw_if_null

(

)

const

Throw an exception if this object is invalid.

void clan::HTTPServerConnection::write_response_data

(

const DataBuffer &

data

)

Write response data.

Parameters

data	= Data Buffer

void clan::HTTPServerConnection::write_response_headers

(

const std::string &

headers

)

Write response headers.

Parameters

headers

= String Ref8

void clan::HTTPServerConnection::write_response_status	(	int	status_code,
		const std::string &	status_text = std::string()
	)

Write response status.

Parameters

status_code	= value
status_text	= String Ref8