OpenSim.Framework.Servers.HttpServer.OSHttpHandler Class Reference

Inheritance diagram for OpenSim.Framework.Servers.HttpServer.OSHttpHandler:

Public Member Functions
	OSHttpHandler (Regex method, Regex path, Dictionary< string, Regex > query, Dictionary< string, Regex > headers, Regex contentType, Regex whitelist)
	Base class constructor. More...
abstract OSHttpHandlerResult	Process (OSHttpRequest request)
	Process an incoming OSHttpRequest that matched our requirements. More...
override string	ToString ()

Protected Attributes
Regex	_method
Regex	_path
Dictionary< string, Regex >	_query
Dictionary< string, Regex >	_headers
Regex	_ipEndPointRegex

Properties
virtual Regex	Method [get]
	Regular expression used to match against method of the incoming HTTP request. If you want to match any string either use '.*' or null. To match on the empty string use '^$'. More...
virtual Regex	Path [get]
	Regular expression used to match against path of the incoming HTTP request. If you want to match any string either use '.*' or null. To match on the empty string use '^$'. More...
virtual Dictionary< string, Regex >	Query [get]
	Dictionary of (query name, regular expression) tuples, allowing us to match on URI query fields. More...
virtual Dictionary< string, Regex >	Headers [get]
	Dictionary of (header name, regular expression) tuples, allowing us to match on HTTP header fields. More...
virtual Regex	IPEndPointWhitelist [get]
	Dictionary of (header name, regular expression) tuples, allowing us to match on HTTP header fields. More...

Detailed Description

Definition at line 69 of file OSHttpHandler.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Servers.HttpServer.OSHttpHandler.OSHttpHandler ( Regex  method, Regex  path, Dictionary< string, Regex >  query, Dictionary< string, Regex >  headers, Regex  contentType, Regex  whitelist  )

inline

Base class constructor.

Parameters

path	null or path regex
headers	null or dictionary of header regexs
contentType	null or content type regex
whitelist	null or IP address regex

Definition at line 140 of file OSHttpHandler.cs.

Member Function Documentation

abstract OSHttpHandlerResult OpenSim.Framework.Servers.HttpServer.OSHttpHandler.Process ( OSHttpRequest  request )

pure virtual

Process an incoming OSHttpRequest that matched our requirements.

Returns

OSHttpHandlerResult.Pass if we are after all not interested in the request; OSHttpHandlerResult.Done if we did process the request.

Implemented in OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler, and OpenSim.Framework.Servers.HttpServer.OSHttpHttpHandler.

override string OpenSim.Framework.Servers.HttpServer.OSHttpHandler.ToString ( )

inline

Definition at line 167 of file OSHttpHandler.cs.

Member Data Documentation

Dictionary<string, Regex> OpenSim.Framework.Servers.HttpServer.OSHttpHandler._headers

protected

Definition at line 113 of file OSHttpHandler.cs.

Regex OpenSim.Framework.Servers.HttpServer.OSHttpHandler._ipEndPointRegex

protected

Definition at line 128 of file OSHttpHandler.cs.

Regex OpenSim.Framework.Servers.HttpServer.OSHttpHandler._method

protected

Definition at line 81 of file OSHttpHandler.cs.

Regex OpenSim.Framework.Servers.HttpServer.OSHttpHandler._path

protected

Definition at line 93 of file OSHttpHandler.cs.

Dictionary<string, Regex> OpenSim.Framework.Servers.HttpServer.OSHttpHandler._query

protected

Definition at line 103 of file OSHttpHandler.cs.

Property Documentation

virtual Dictionary<string, Regex> OpenSim.Framework.Servers.HttpServer.OSHttpHandler.Headers

get

Dictionary of (header name, regular expression) tuples, allowing us to match on HTTP header fields.

Definition at line 110 of file OSHttpHandler.cs.

virtual Regex OpenSim.Framework.Servers.HttpServer.OSHttpHandler.IPEndPointWhitelist

get

Dictionary of (header name, regular expression) tuples, allowing us to match on HTTP header fields.

This feature is currently not implemented as it requires (trivial) changes to HttpServer.HttpListener that have not been implemented.

Definition at line 125 of file OSHttpHandler.cs.

virtual Regex OpenSim.Framework.Servers.HttpServer.OSHttpHandler.Method

get

Regular expression used to match against method of the incoming HTTP request. If you want to match any string either use '.*' or null. To match on the empty string use '^$'.

Definition at line 78 of file OSHttpHandler.cs.

virtual Regex OpenSim.Framework.Servers.HttpServer.OSHttpHandler.Path

get

Regular expression used to match against path of the incoming HTTP request. If you want to match any string either use '.*' or null. To match on the empty string use '^$'.

Definition at line 90 of file OSHttpHandler.cs.

virtual Dictionary<string, Regex> OpenSim.Framework.Servers.HttpServer.OSHttpHandler.Query

get

Dictionary of (query name, regular expression) tuples, allowing us to match on URI query fields.

Definition at line 100 of file OSHttpHandler.cs.

---

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

• Framework/Servers/HttpServer/OSHttpHandler.cs