Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetailsBuilder Interface Reference

The service topic details builder. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetailsBuilder:
PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder

Public Member Functions

IServiceTopicDetailsBuilder SetServiceType (string serviceType)
 Sets the service type. More...
 
IServiceTopicDetailsBuilder SetHandler (string handlerClass)
 Sets the name of a service handler class to handle service requests at the server. More...
 
IServiceTopicDetailsBuilder SetRequestTimeout (long timeout)
 Sets the request timeout. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >
new TB SetReference (string reference)
 Sets the initial value of the topic reference. More...
 
new TB SetTidyOnUnsubscribe (bool tidy)
 Sets the 'tidy on unsubscribe' flag. More...
 
new TB SetProperty (string key, string value)
 Sets a topic property. More...
 
new TB Reset ()
 Resets the builder to its initial values. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >
new TD Build ()
 Build the content. More...
 

Detailed Description

The service topic details builder.

Member Function Documentation

IServiceTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetailsBuilder.SetHandler ( string  handlerClass)

Sets the name of a service handler class to handle service requests at the server.

If this is not specified, service requests will be delegated to the 'ServiceProvider' feature.

Parameters
handlerClassThe service handler class name. Specifying a zero-length string effectively removes any previously-specified handler.
Returns
This builder.
IServiceTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetailsBuilder.SetRequestTimeout ( long  timeout)

Sets the request timeout.

This is the period of time allowed after a service request is received by the server for the request to complete (a response returned to the server for forwarding to the requesting client). If this period expires before a response is returned then the request is abandoned and a timeout notification sent to the requesting client.

Any response that is returned to the server after the timeout period is discarded.

If this is not explicitly specified then 5 seconds (5000) is assumed.

Parameters
timeoutThe request timeout in milliseconds.
Returns
This builder.
IServiceTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IServiceTopicDetailsBuilder.SetServiceType ( string  serviceType)

Sets the service type.

This type is the way in which the service is identified to the client so that the client is able to understand the type of service it is interacting with.

If no service type is explicitly specified then it will be assumed to be a zero-length string.

Parameters
serviceTypeThe service type.
Returns
This builder.

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