Diffusion .NET Client Library  6.1.5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Features.Control.Clients.QueueEventHandlerDefault Class Reference

Provides a default handler implementation which will simply log client state events. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.Control.Clients.QueueEventHandlerDefault:
PushTechnology.ClientInterface.Client.Features.Control.Clients.IQueueEventHandler PushTechnology.ClientInterface.Client.Features.IServerHandler

Public Member Functions

virtual void OnActive (IRegisteredHandler registeredHandler)
 Called when the handler has been registered at the server and is now active. More...
 
virtual void OnClose ()
 Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered. More...
 
virtual void OnUpperThresholdCrossed (ISessionId client, IMessageQueuePolicy policy)
 The configured upper queue threshole for a client's queue has been reached. More...
 
virtual void OnLowerThresholdCrossed (ISessionId client, IMessageQueuePolicy policy)
 The configured lower threshold for a client's queue has been reached. More...
 

Detailed Description

Provides a default handler implementation which will simply log client state events.

Member Function Documentation

virtual void PushTechnology.ClientInterface.Client.Features.Control.Clients.QueueEventHandlerDefault.OnActive ( IRegisteredHandler  registeredHandler)
virtual

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.

Implements PushTechnology.ClientInterface.Client.Features.IServerHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Clients.QueueEventHandlerDefault.OnClose ( )
virtual

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

Implements PushTechnology.ClientInterface.Client.Features.IServerHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Clients.QueueEventHandlerDefault.OnLowerThresholdCrossed ( ISessionId  client,
IMessageQueuePolicy  policy 
)
virtual

The configured lower threshold for a client's queue has been reached.

Parameters
clientThe client session identifier.
policyThe message queue policy.

Implements PushTechnology.ClientInterface.Client.Features.Control.Clients.IQueueEventHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Clients.QueueEventHandlerDefault.OnUpperThresholdCrossed ( ISessionId  client,
IMessageQueuePolicy  policy 
)
virtual

The configured upper queue threshole for a client's queue has been reached.

Parameters
clientThe client session identifier.
policyThe message queue policy.

Implements PushTechnology.ClientInterface.Client.Features.Control.Clients.IQueueEventHandler.


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