Interface ITopicTreeHandler
The interface for callback handlers that establish a server side control presence for the client ISession at a particular branch of the topic tree.
Namespace: PushTechnology.ClientInterface.Client.Features
Assembly: Diffusion.Client.dll
Syntax
public interface ITopicTreeHandler
Remarks
Caution
Deprecated since 6.7. This interface is only used by deprecated methods and will be removed in a future release.
Methods
OnActive(String, IRegisteredHandler)
Called when the handler has been registered at the server and is now active.
Declaration
void OnActive(string topicPath, IRegisteredHandler registeredHandler)
Parameters
Type | Name | Description |
---|---|---|
String | topicPath | The path that the handler is active for. |
IRegisteredHandler | registeredHandler | The registration that is able to close the handler. |
Remarks
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 using CloseAsync().
OnClose(String)
Called if the handler is closed.
Declaration
void OnClose(string topicPath)
Parameters
Type | Name | Description |
---|---|---|
String | topicPath | The branch of the topic tree for which the handler was registered. |
Remarks
The handler will be closed if the session is closed after the handler has been registered, or if the handler is unregistered using CloseAsync().