Photon Server API
Classes | Public Member Functions | Properties | List of all members
Photon.SocketServer.Web.HttpApplicationHandler Class Reference

IHttpAsyncHandler implementation to host photon applications in a web application. More...

Inheritance diagram for Photon.SocketServer.Web.HttpApplicationHandler:

Public Member Functions

 HttpApplicationHandler (IPhotonApplication photonApplication, string applicationName)
 Initializes a new instance of the HttpApplicationHandler class. More...
 
 HttpApplicationHandler (IPhotonApplication photonApplication, string applicationName, TimeSpan peerExpiration)
 Initializes a new instance of the HttpApplicationHandler class. More...
 
IAsyncResult BeginProcessRequest (HttpContext context, AsyncCallback cb, object extraData)
 Initiates an asynchronous call to the HTTP handler. More...
 
void EndProcessRequest (IAsyncResult result)
 Provides an asynchronous process End method when the process of a request ends. More...
 
void ProcessRequest (HttpContext context)
 Not implemented. More...
 
IPhotonPeer ConnectHixie76WebSocket (string ipAddress, ushort port, string url, string origin, object userData)
 Not implemented. More...
 
IPhotonPeer ConnectWebSocket (string ipAddress, ushort port, WebSocketVersion version, string url, string subProtocols, object userData)
 Not implemented. More...
 

Properties

bool IsReusable [get]
 Gets a value indicating whether another request can use the IHttpHandler instance. Returns always true. More...
 

Detailed Description

IHttpAsyncHandler implementation to host photon applications in a web application.

Constructor & Destructor Documentation

Photon.SocketServer.Web.HttpApplicationHandler.HttpApplicationHandler ( IPhotonApplication  photonApplication,
string  applicationName 
)
inline

Initializes a new instance of the HttpApplicationHandler class.

Parameters
photonApplicationThe photon application to host.
applicationNameThe application name.
Photon.SocketServer.Web.HttpApplicationHandler.HttpApplicationHandler ( IPhotonApplication  photonApplication,
string  applicationName,
TimeSpan  peerExpiration 
)
inline

Initializes a new instance of the HttpApplicationHandler class.

Parameters
photonApplicationThe photon application to host.
applicationNameThe application name.
peerExpirationThe time after which a peer will be diconnected due inactivity. The default value is 30 seconds.

Member Function Documentation

IAsyncResult Photon.SocketServer.Web.HttpApplicationHandler.BeginProcessRequest ( HttpContext  context,
AsyncCallback  cb,
object  extraData 
)
inline

Initiates an asynchronous call to the HTTP handler.

Parameters
contextAn HttpContext object used to service HTTP requests.
cbThe AsyncCallback to call when the asynchronous method call is complete.
extraDataAny extra data needed to process the request.
Returns
An IAsyncResult that contains information about the status of the process.
IPhotonPeer Photon.SocketServer.Web.HttpApplicationHandler.ConnectHixie76WebSocket ( string  ipAddress,
ushort  port,
string  url,
string  origin,
object  userData 
)
inline

Not implemented.

IPhotonPeer Photon.SocketServer.Web.HttpApplicationHandler.ConnectWebSocket ( string  ipAddress,
ushort  port,
WebSocketVersion  version,
string  url,
string  subProtocols,
object  userData 
)
inline

Not implemented.

void Photon.SocketServer.Web.HttpApplicationHandler.EndProcessRequest ( IAsyncResult  result)
inline

Provides an asynchronous process End method when the process of a request ends.

Parameters
resultAn IAsyncResult that contains information about the status of the process.
void Photon.SocketServer.Web.HttpApplicationHandler.ProcessRequest ( HttpContext  context)
inline

Not implemented.

Parameters
context

Property Documentation

bool Photon.SocketServer.Web.HttpApplicationHandler.IsReusable
get

Gets a value indicating whether another request can use the IHttpHandler instance. Returns always true.