C# Class Examples.ExampleControlAuthenticationHandler

Implementation of IControlAuthenticationHandler.

Inheritance: IControlAuthenticationHandler

Mostra file Open project: pushtechnology/diffusion-examples

Public Methods

Method	Description
Authenticate ( string principal, ICredentials credentials, ISessionDetails sessionDetails, IAuthenticationHandlerCallback callback ) : void	Request authentication. The server calls this to authenticate new sessions, and when a client requests the session principal is changed. For each call to Authenticate, the authentication handler should respond by calling one of the methods of the provided callback. The handler may return immediately and process the authentication request asynchronously. The client session will be blocked until a callback method is called.
OnActive ( IRegisteredHandler registeredHandler ) : void	Called when the handler has been registered at the server and is now active. A session can register at most one a single handler of each type. If there is already a handler registered for the topic path the operation will fail, the registered handler will be closed, and the session error handler will be notified. To change the handler, first close the previous handler.
OnClose ( ) : void	Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered.

Method Details

Authenticate() public method

Request authentication. The server calls this to authenticate new sessions, and when a client requests the session principal is changed. For each call to Authenticate, the authentication handler should respond by calling one of the methods of the provided callback. The handler may return immediately and process the authentication request asynchronously. The client session will be blocked until a callback method is called.

public Authenticate ( string principal, ICredentials credentials, ISessionDetails sessionDetails, IAuthenticationHandlerCallback callback ) : void
principal	string
credentials	ICredentials
sessionDetails	ISessionDetails
callback	IAuthenticationHandlerCallback
return	void

OnActive() public method

Called when the handler has been registered at the server and is now active. A session can register at most one a single handler of each type. If there is already a handler registered for the topic path the operation will fail, the registered handler will be closed, and the session error handler will be notified. To change the handler, first close the previous handler.

public OnActive ( IRegisteredHandler registeredHandler ) : void
registeredHandler	IRegisteredHandler
return	void

OnClose() public method

Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered.

public OnClose ( ) : void
return	void