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

Default implementation of IMessageHandler that simply logs the inbound content. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Features.Control.Topics.MessageReceiverDefault:
PushTechnology.ClientInterface.Client.Features.Control.Topics.IMessageHandler PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler

Public Member Functions

virtual void OnActive (string topicPath, IRegisteredHandler registeredHandler)
 Called when the handler has been registered at the server and is now active. More...
 
virtual void OnClose (string topicPath)
 Called if the handler is closed. This happens if the call to register the handler fails, or the handler is unregistered. More...
 
virtual void OnMessage (ISessionId sessionId, string topicPath, IContent content, IReceiveContext context)
 Receives content sent from a session via a topic. More...
 

Detailed Description

Default implementation of IMessageHandler that simply logs the inbound content.

Member Function Documentation

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.MessageReceiverDefault.OnActive ( string  topicPath,
IRegisteredHandler  registeredHandler 
)
virtual

Called when the handler has been registered at the server and is now active.

A session can register a single handler of each type for a given branch of the topic tree. If there is already a handler registered for the topic path 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
topicPathThe path that the handler is active for.
registeredHandlerAllows the handler to be closed.

Implements PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.MessageReceiverDefault.OnClose ( string  topicPath)
virtual

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

Parameters
topicPath

Implements PushTechnology.ClientInterface.Client.Features.ITopicTreeHandler.

virtual void PushTechnology.ClientInterface.Client.Features.Control.Topics.MessageReceiverDefault.OnMessage ( ISessionId  sessionId,
string  topicPath,
IContent  content,
IReceiveContext  context 
)
virtual

Receives content sent from a session via a topic.

Parameters
sessionIdIdentifies the client session that sent the content.
topicPathThe path of the topic that the content was sent on.
contentThe content sent by the client.
contextThe context associated with the content.

Implements PushTechnology.ClientInterface.Client.Features.Control.Topics.IMessageHandler.


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