Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Callbacks.IServerHandler Interface Reference

Common interface for callback handlers that establish a server side control presence for the client session. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Callbacks.IServerHandler:
PushTechnology.ClientInterface.Client.Callbacks.DefaultServerHandler PushTechnology.ClientInterface.Client.Features.Control.Clients.ISessionPropertiesListener PushTechnology.ClientInterface.Client.Features.Control.Clients.SessionPropertiesListenerDefault

Public Member Functions

void OnRegistered (IRegistration registration)
 Called when the handler has been successfully registered with the server. More...
 
void OnClose ()
 Called if the handler is closed. The handler will be closed if the session is closed after the handler has been registered, or if the handler is unregistered using close. More...
 
void OnError (ErrorReason errorReason)
 Notification of a contextual error related to this handler. This is analogous to an unchecked exception being raised. Situations in which onError is called include the session being closed before the handler is registered, a communication timeout, or a problem with the provided parameters. No further calls will be made to this handler. More...
 

Detailed Description

Common interface for callback handlers that establish a server side control presence for the client session.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Callbacks.IServerHandler.OnClose ( )

Called if the handler is closed. The handler will be closed if the session is closed after the handler has been registered, or if the handler is unregistered using close.

No further calls will be made for the handler.

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultServerHandler, and PushTechnology.ClientInterface.Client.Features.Control.Clients.SessionPropertiesListenerDefault.

void PushTechnology.ClientInterface.Client.Callbacks.IServerHandler.OnError ( ErrorReason  errorReason)

Notification of a contextual error related to this handler. This is analogous to an unchecked exception being raised. Situations in which onError is called include the session being closed before the handler is registered, a communication timeout, or a problem with the provided parameters. No further calls will be made to this handler.

Parameters
errorReasona value representing the error; this can be one of constants defined in ErrorReason, or a feature-specific reason

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultServerHandler, and PushTechnology.ClientInterface.Client.Features.Control.Clients.SessionPropertiesListenerDefault.

void PushTechnology.ClientInterface.Client.Callbacks.IServerHandler.OnRegistered ( IRegistration  registration)

Called when the handler has been successfully registered with the server.

A session can register at most one a single handler of each type. If there is already a handler registered the operation will fail, registeredHandler will be closed, and the session error handler will be notified. To change the handler, first close the previous handler.

Parameters
registrationreference that allows the handler to be closed

Implemented in PushTechnology.ClientInterface.Client.Callbacks.DefaultServerHandler, and PushTechnology.ClientInterface.Client.Features.Control.Clients.SessionPropertiesListenerDefault.


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