PushTechnology.ClientInterface.Client.Features.Control.Topics.IRoutingSubscriptionRequest Interface Reference

Encapsulates a request to subscribe to routing topics and a mechanism for actioning the subscription. More...

Public Member Functions
void	Defer ()
	Defers the handling of this routing topic. Further action may be manually initiated, either from this control client or from the server, but will not retain the context of this original request. More...
void	Route (string topicPath, ISubscriptionCallback callback)
	Provide a topic path to which the requested client will be routed via the routing topic. More...
void	Route< TC > (string topicPath, TC context, ISubscriptionContextCallback< TC > callback)
	Provide a topic path to which the requested client will be routed via the routing topic, with a contextual object. More...

Properties
ISessionId	SessionId [get]
	Identifies the client making the subscription request. More...
string	TopicPath [get]
	Identifies the topic that the client is requesting subscribe to. More...

Detailed Description

Encapsulates a request to subscribe to routing topics and a mechanism for actioning the subscription.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IRoutingSubscriptionRequest.Defer

(

)

Defers the handling of this routing topic. Further action may be manually initiated, either from this control client or from the server, but will not retain the context of this original request.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IRoutingSubscriptionRequest.Route	(	string	topicPath,
		ISubscriptionCallback	callback
	)

Provide a topic path to which the requested client will be routed via the routing topic.

Parameters

topicPath	The topic path that should be used for routing.
callback	Provides callback methods indicating the status of this request.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IRoutingSubscriptionRequest.Route< TC >	(	string	topicPath,
		TC	context,
		ISubscriptionContextCallback< TC >	callback
	)

Provide a topic path to which the requested client will be routed via the routing topic, with a contextual object.

Template Parameters

TC	The context object type.

Parameters

topicPath	The topic path that should be used for routing.
context	Passed to the callback with the reply to allow requests and replies to be correlated. The caller may use any convenient object reference, including null.
callback	Provides callback methods indicating the status of this request, bound with the context.

Property Documentation

ISessionId PushTechnology.ClientInterface.Client.Features.Control.Topics.IRoutingSubscriptionRequest.SessionId

get

Identifies the client making the subscription request.

string PushTechnology.ClientInterface.Client.Features.Control.Topics.IRoutingSubscriptionRequest.TopicPath

get

Identifies the topic that the client is requesting subscribe to.

---

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

• LegacyModule/Client/Features/Control/Topics/IRoutingSubscriptionRequest.cs