Sirikata::Command::HttpCommander Class Reference

#include <HttpCommander.hpp>

Inheritance diagram for Sirikata::Command::HttpCommander:

Collaboration diagram for Sirikata::Command::HttpCommander:

List of all members.

Public Member Functions
	HttpCommander (Context *ctx, const String &host, uint16 port)
virtual	~HttpCommander ()
virtual void	onHttpRequest (HttpServer *server, HttpRequestID id, String &path, String &query, String &fragment, Headers &headers, String &body)
	Invoked when a complete HttpRequest is ready for processing.
virtual void	result (CommandID id, const Result &result)
	Return a result from a CommandHandler.
Private Member Functions
void	sendResponse (HttpRequestID id, HttpStatus status, const Result &result)
Private Attributes
Context *	mContext
HttpServer	mServer

---

Constructor & Destructor Documentation

Sirikata::Command::HttpCommander::HttpCommander	(	Context *	ctx,
		const String &	host,
		uint16	port
	)

References Sirikata::Provider< ListenerPtr >::addListener(), mContext, mServer, and Sirikata::Context::setCommander().

Sirikata::Command::HttpCommander::~HttpCommander

(

)

[virtual]

References mContext, mServer, Sirikata::Provider< ListenerPtr >::removeListener(), and Sirikata::Context::setCommander().

---

Member Function Documentation

void Sirikata::Command::HttpCommander::onHttpRequest	(	HttpServer *	server,
		HttpRequestID	id,
		String &	path,
		String &	query,
		String &	fragment,
		Headers &	headers,
		String &	body
	)		[virtual]

Invoked when a complete HttpRequest is ready for processing.

Parameters:

server	the HttpServer this request originated from
id	the unique ID for this request. Should be included when triggering the response
path	path part of the requested URL
query	(encoded) query string part of the requested URL
fragment	fragment part of the requested URL
headers	map of headers included with the request
body	the body of the request

Note:

Parameters are passed as mutable references -- you are permitted to modify them. They will remain valid until you call HttpServer::response().

Implements Sirikata::Command::HttpRequestListener.

References Sirikata::Command::CommandSetName(), Sirikata::Logging::detailed, Sirikata::Command::EmptyResult(), Sirikata::Command::Commander::getHandler(), HC_LOG, result(), and sendResponse().

void Sirikata::Command::HttpCommander::result	(	CommandID	id,
		const Result &	result
	)		[virtual]

Return a result from a CommandHandler.

This will trigger the process of returning the result to the requestor.

Implements Sirikata::Command::Commander.

References sendResponse().

Referenced by onHttpRequest().

void Sirikata::Command::HttpCommander::sendResponse	(	HttpRequestID	id,
		HttpStatus	status,
		const Result &	result
	)		[private]

References HC_LOG, Sirikata::Logging::insane, mServer, and Sirikata::Command::HttpServer::response().

Referenced by onHttpRequest(), and result().

---

Member Data Documentation

Context* Sirikata::Command::HttpCommander::mContext [private]

Referenced by HttpCommander(), and ~HttpCommander().

HttpServer Sirikata::Command::HttpCommander::mServer [private]

Referenced by HttpCommander(), sendResponse(), and ~HttpCommander().

---

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

• libcore/plugins/http/HttpCommander.hpp
• libcore/plugins/http/HttpCommander.cpp