OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | List of all members
OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler Class Reference
Inheritance diagram for OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler:
Collaboration graph
[legend]

Public Member Functions

 OSHttpXmlRpcHandler (XmlRpcMethod handler, string methodName, Regex path, Dictionary< string, Regex > headers, Regex whitelist)
 Instantiate an XmlRpc handler. More...
 
 OSHttpXmlRpcHandler (XmlRpcMethod handler, string methodName)
 Instantiate an XmlRpc handler. More...
 
override OSHttpHandlerResult Process (OSHttpRequest request)
 Invoked by OSHttpRequestPump. More...
 
- Public Member Functions inherited from OpenSim.Framework.Servers.HttpServer.OSHttpHandler
 OSHttpHandler (Regex method, Regex path, Dictionary< string, Regex > query, Dictionary< string, Regex > headers, Regex contentType, Regex whitelist)
 Base class constructor. More...
 
override string ToString ()
 

Protected Member Functions

bool XmlRpcMethodMatch (OSHttpRequest req)
 XmlRpcMethodMatch tries to reify (deserialize) an incoming XmlRpc request (and posts it to the "whiteboard") and checks whether the method name is one we are interested in. More...
 

Additional Inherited Members

- Protected Attributes inherited from OpenSim.Framework.Servers.HttpServer.OSHttpHandler
Regex _method
 
Regex _path
 
Dictionary< string, Regex > _query
 
Dictionary< string, Regex > _headers
 
Regex _ipEndPointRegex
 
- Properties inherited from OpenSim.Framework.Servers.HttpServer.OSHttpHandler
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 43 of file OSHttpXmlRpcHandler.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler.OSHttpXmlRpcHandler ( XmlRpcMethod  handler,
string  methodName,
Regex  path,
Dictionary< string, Regex >  headers,
Regex  whitelist 
)
inline

Instantiate an XmlRpc handler.

Parameters
handlerXmlRpcMethod delegate
methodNameXmlRpc method name
pathXmlRpc path prefix (regular expression)
headersDictionary with header names and regular expressions to match content of headers
whitelistIP whitelist of remote end points to accept (regular expression)

Except for handler and methodName, all other parameters can be null, in which case they are not taken into account when the handler is being looked up.

Definition at line 116 of file OSHttpXmlRpcHandler.cs.

OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler.OSHttpXmlRpcHandler ( XmlRpcMethod  handler,
string  methodName 
)
inline

Instantiate an XmlRpc handler.

Parameters
handlerXmlRpcMethod delegate
methodNameXmlRpc method name

Definition at line 133 of file OSHttpXmlRpcHandler.cs.

Member Function Documentation

override OSHttpHandlerResult OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler.Process ( OSHttpRequest  request)
inlinevirtual
bool OpenSim.Framework.Servers.HttpServer.OSHttpXmlRpcHandler.XmlRpcMethodMatch ( OSHttpRequest  req)
inlineprotected

XmlRpcMethodMatch tries to reify (deserialize) an incoming XmlRpc request (and posts it to the "whiteboard") and checks whether the method name is one we are interested in.

Returns
true if the handler is interested in the content; false otherwise

Definition at line 55 of file OSHttpXmlRpcHandler.cs.


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