RequestHandlers handle requests for a file or path. More...

#include "httpserver.h"

Inheritance diagram for ion::remote::HttpServer::RequestHandler:

Collaboration diagram for ion::remote::HttpServer::RequestHandler:

Public Member Functions
virtual const std::string	HandleRequest (const std::string &path, const QueryMap &args, std::string *content_type)=0
	The HandleRequest() function is passed the path (relative to its base path) of the file or directory to serve, and any query arguments associated with the request. More...

virtual const WebsocketPtr	ConnectWebsocket (const std::string &path, const QueryMap &args)
	By default, RequestHandlers don't support websocket connections. More...

const std::string &	GetBasePath () const
	Returns the path this handler is registered at. More...

const AllocatorPtr &	GetAllocator () const
	Returns the Allocator that was used for the instance. More...

const AllocatorPtr &	GetNonNullAllocator () const
	Return our allocator, or the default allocator if the instance was declared on the stack. More...

const AllocatorPtr &	GetAllocatorForLifetime (AllocationLifetime lifetime) const
	Convenience function that returns the Allocator to use to allocate an object with a specific lifetime. More...

void *	operator new (size_t size)
	The standard no-parameter new operator uses the default Allocator. More...

void *	operator new (size_t size, AllocationLifetime lifetime)
	This overloaded version of the new operator uses the AllocationManager's default Allocator for the specified lifetime. More...

void *	operator new (size_t size, const AllocatorPtr &allocator)
	This overloaded version of the new operator takes the Allocator to use directly as a parameter. More...

void *	operator new (size_t size, const AllocatorPtr &allocator, void *ptr)
	Special operator new for using placement new with Allocatables. More...

void *	operator new (size_t size, void *ptr)
	The placement new operator is defined conventionally. More...

void	operator delete (void *ptr)
	Define the delete operator to use specialized functions dealing with an Allocator. More...

void	operator delete (void *ptr, AllocationLifetime lifetime)
	Windows requires these (or it issues C4291 warnings). More...

void	operator delete (void *ptr, const AllocatorPtr &allocator)

void	operator delete (void ptr, void ptr2)
	The placement delete operator does nothing, as usual. More...

int	GetRefCount () const
	GetRefCount() is part of the interface necessary for SharedPtr. More...

Protected Member Functions
	RequestHandler (const std::string &base_path)
	The constructor is protected since this is an abstract base class. More...

	~RequestHandler () override
	The destructor is protected since this derived from base::Referent. More...

Detailed Description

RequestHandlers handle requests for a file or path.

Definition at line 68 of file httpserver.h.

Constructor & Destructor Documentation

ion::remote::HttpServer::RequestHandler::RequestHandler ( const std::string & base_path )

explicitprotected

The constructor is protected since this is an abstract base class.

It takes the absolute path that this handler will be registered at. The registration may be for a specific file or for a directory hierarchy. If the handler's path is a path to a file, then handler is invoked when the file is requested. If path is a directory, then HandleRequest() is invoked for any request in or below that directory, unless another handler overrides a file or sub-directory within it.

Note: if a handler is registered to return data for a directory then it must correctly handle .htpasswd files by returning either an empty string or a valid .htpasswd file. Failure to do this will likely result in the server returning 401 errors.

Definition at line 654 of file httpserver.cc.

ion::remote::HttpServer::RequestHandler::~RequestHandler ( )

overrideprotected

The destructor is protected since this derived from base::Referent.

Definition at line 657 of file httpserver.cc.

Member Function Documentation

virtual const WebsocketPtr ion::remote::HttpServer::RequestHandler::ConnectWebsocket	(	const std::string &	path,
		const QueryMap &	args
	)

inlinevirtual

By default, RequestHandlers don't support websocket connections.

Definition at line 86 of file httpserver.h.

const AllocatorPtr& ion::base::Allocatable::GetAllocator ( ) const

inlineinherited

Returns the Allocator that was used for the instance.

This will be NULL if the instance was declared on the stack or created with normal placement new.

Definition at line 68 of file allocatable.h.

References allocator_.

Referenced by ion::base::DataContainer::CreateAndCopy(), ion::text::DynamicFontImage::FindContainingImageDataIndex(), and ion::text::DynamicFontImage::FindImageDataIndex().

const AllocatorPtr& ion::base::Allocatable::GetAllocatorForLifetime ( AllocationLifetime lifetime ) const

inlineinherited

Convenience function that returns the Allocator to use to allocate an object with a specific lifetime.

Definition at line 78 of file allocatable.h.

References ion::base::Allocator::GetAllocatorForLifetime().

Referenced by ion::text::BasicBuilder::BuildVertexData(), ion::text::OutlineBuilder::BuildVertexData(), ion::gfxutils::ShaderManager::CreateShaderProgram(), ion::text::DynamicFontImage::FindContainingImageDataIndex(), ion::text::DynamicFontImage::FindImageDataIndex(), ion::gfx::Renderer::Renderer(), and ion::gfx::UpdateStateTable().

const std::string& ion::remote::HttpServer::RequestHandler::GetBasePath ( ) const

inline

Returns the path this handler is registered at.

Definition at line 92 of file httpserver.h.

const AllocatorPtr& ion::base::Allocatable::GetNonNullAllocator ( ) const

inlineinherited

Return our allocator, or the default allocator if the instance was declared on the stack.

Definition at line 72 of file allocatable.h.

References allocator_, and ion::base::AllocationManager::GetNonNullAllocator().

int ion::base::Shareable::GetRefCount ( ) const

inlineinherited

GetRefCount() is part of the interface necessary for SharedPtr.

Definition at line 34 of file shareable.h.

Referenced by ion::base::Notifier::RemoveReceiver().

virtual const std::string ion::remote::HttpServer::RequestHandler::HandleRequest	(	const std::string &	path,
		const QueryMap &	args,
		std::string *	content_type
	)

pure virtual

The HandleRequest() function is passed the path (relative to its base path) of the file or directory to serve, and any query arguments associated with the request.

The handler should return an empty string if it cannot handle the request. The handler may optionally set a specific content type to be returned in the response headers. If the handler does not set a content type then a suitable one will be chosen based on the extension of the requested file.

Note: if a handler is registered to serve just a single filename then the path passed to it will be "", since that is the relative path from a file to itself.

Implemented in ion::remote::ShaderHandler, ion::remote::NodeGraphHandler, ion::remote::TracingHandler, ion::remote::SettingHandler, ion::remote::ResourceHandler, and ion::remote::CallTraceHandler.

void ion::base::Allocatable::operator delete ( void * ptr )

inlineinherited

Define the delete operator to use specialized functions dealing with an Allocator.

Definition at line 109 of file allocatable.h.

void ion::base::Allocatable::operator delete	(	void *	ptr,
		AllocationLifetime	lifetime
	)

inlineinherited

Windows requires these (or it issues C4291 warnings).

Definition at line 112 of file allocatable.h.

void ion::base::Allocatable::operator delete	(	void *	ptr,
		const AllocatorPtr &	allocator
	)

inlineinherited

Definition at line 113 of file allocatable.h.

void ion::base::Allocatable::operator delete	(	void *	ptr,
		void *	ptr2
	)

inlineinherited

The placement delete operator does nothing, as usual.

Definition at line 118 of file allocatable.h.

void* ion::base::Allocatable::operator new ( size_t size )

inlineinherited

The standard no-parameter new operator uses the default Allocator.

Definition at line 84 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		AllocationLifetime	lifetime
	)

inlineinherited

This overloaded version of the new operator uses the AllocationManager's default Allocator for the specified lifetime.

Definition at line 88 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		const AllocatorPtr &	allocator
	)

inlineinherited

This overloaded version of the new operator takes the Allocator to use directly as a parameter.

If the Allocator pointer is NULL, this uses the default Allocator.

Definition at line 95 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		const AllocatorPtr &	allocator,
		void *	ptr
	)

inlineinherited

Special operator new for using placement new with Allocatables.

Definition at line 100 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		void *	ptr
	)

inlineinherited

The placement new operator is defined conventionally.

Definition at line 105 of file allocatable.h.

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

remote/httpserver.h
remote/httpserver.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation