ofx::HTTP::FileSystemRoute Class Reference

A route for serving files from the file system. More...

#include <FileSystemRoute.h>

Inheritance diagram for ofx::HTTP::FileSystemRoute:

Public Types
typedef FileSystemRouteSettings	Settings

Public Member Functions
	FileSystemRoute (const Settings &settings)
virtual void	handleRequest (ServerEventArgs &evt) override
	Handle the ServerEventArgs. More...
virtual void	handleErrorResponse (ServerEventArgs &evt)
Poco::Net::HTTPRequestHandler *	createRequestHandler (const Poco::Net::HTTPServerRequest &request) override
	Creates a new HTTPRequestHandler for the given request. More...
Public Member Functions inherited from ofx::HTTP::BaseRoute_< FileSystemRouteSettings >
	BaseRoute_ (const FileSystemRouteSettings &settings=FileSystemRouteSettings())
	Create a BaseRoute. More...
virtual	~BaseRoute_ ()
	Destroy a BaseRoute.
virtual void	setup (const FileSystemRouteSettings &settings)
	Setup the route with settings. More...
virtual std::string	routePathPattern () const override
	Get the route's regex path pattern. More...
virtual bool	canHandleRequest (const Poco::Net::HTTPServerRequest &request, bool isSecurePort) const override
	Determine if this route can handle the given request. More...
void	handleRequest (Poco::Net::HTTPServerRequest &request, Poco::Net::HTTPServerResponse &response) override
virtual void	stop () override
	Stop any pending activity and close this route. More...
const FileSystemRouteSettings &	settings () const
AbstractServer *	getServer () override
void	setServer (AbstractServer *server) override
	Set the server that owns this route. More...
Public Member Functions inherited from ofx::HTTP::AbstractRoute
virtual	~AbstractRoute ()
	Destroy the AbstractRoute instance.
Public Member Functions inherited from ofx::HTTP::AbstractHTTPRequestHandler
virtual	~AbstractHTTPRequestHandler ()
	Destroy the AbstractHTTPRequestHandler.
Public Member Functions inherited from ofx::HTTP::AbstractServerEventRequestHandler
virtual	~AbstractServerEventRequestHandler ()
	Destroy the AbstractServerEventRequestHandler.
Public Member Functions inherited from ofx::HTTP::AbstractHTTPRequestHandlerFactory
virtual	~AbstractHTTPRequestHandlerFactory ()
	Destroy the AbstractHTTPRequestHandlerFactory.

Additional Inherited Members
Protected Attributes inherited from ofx::HTTP::BaseRoute_< FileSystemRouteSettings >
FileSystemRouteSettings	_settings
	The settings.
AbstractServer *	_server
	A pointer to the server.

Detailed Description

A route for serving files from the file system.

Member Function Documentation

createRequestHandler()

Poco::Net::HTTPRequestHandler * ofx::HTTP::FileSystemRoute::createRequestHandler ( const Poco::Net::HTTPServerRequest &  request )

overridevirtual

Creates a new HTTPRequestHandler for the given request.

Before this is called, it is expected that the calling server has confirmed that this route is capable of handling the request by calling canHandleRequest().

Parameters

request

The HTTPServerRequest to be passed to the handler.

Returns

An HTTPRequestHandler that will handle the request.

Note

Redeclared here for documentation puposes.

Reimplemented from ofx::HTTP::BaseRoute_< FileSystemRouteSettings >.

handleRequest()

void ofx::HTTP::FileSystemRoute::handleRequest ( ServerEventArgs &  evt )

overridevirtual

Handle the ServerEventArgs.

Parameters

evt	The server request event.

Accept-Encoding:gzip, deflate, sdch

Reimplemented from ofx::HTTP::BaseRoute_< FileSystemRouteSettings >.

---

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

• FileSystemRoute.h
• FileSystemRoute.cpp