DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
DFServiceTopicHandler Class Reference

The class for making and handling service calls to topics with service topicdata. More...

#import <DFServiceTopicHandler.h>

Inheritance diagram for DFServiceTopicHandler:
Collaboration diagram for DFServiceTopicHandler:

Instance Methods

(NSString *) - sendRequest:withRequestType:
 Sends a request to the Service.
 
(NSString *) - sendRequest:withRequestType:andUID:
 Sends a request to the Service.
 
(NSString *) - getNextRequestID
 Get the next unique request ID for use with sendRequest:withRequestType:andUID:
 
- Instance Methods inherited from <DFTopicListenerDelegate>
(BOOL) - onMessage:
 This method is called if the TopicMessage matches the message received from Diffusion.
 
(NSString *) - getTopic
 getTopic.
 

Properties

NSString * serviceType
 The symbolic 'service' type' string returned from the service upon subscription.
 
NSString * topic
 Topic to which this service is bound.
 
DFTopicMessageserviceData
 Returns a message containing any fixed data returned upon subscription.
 
DFClientclient
 Returns the client connection.
 

Detailed Description

The class for making and handling service calls to topics with service topicdata.

Method Documentation

- (NSString*) sendRequest: (DFTopicMessage *)  message
withRequestType: (NSString *)  type 

Sends a request to the Service.

If the request succeeds then a response will be returned on [DFServiceTopicDelegate serviceResponse:] and if it fails or is timed out at the server then an error will be returned on [DFServiceTopicDelegate serviceError:].

Parameters
typeThe request type. This must be one of the allowed types for the service.
messageOptional request data. If supplied then the headers and data from the given Message will be sent with the request.
Returns
unique request identifier
- (NSString*) sendRequest: (DFTopicMessage *)  message
withRequestType: (NSString *)  type
andUID: (NSString *)  uid 

Sends a request to the Service.

If the request succeeds then a response will be returned on [DFServiceTopicDelegate serviceResponse:] and if it fails or is timed out at the server then an error will be returned on [DFServiceTopicDelegate serviceError:].

Parameters
typeThe request type. This must be one of the allowed types for the service.
messageOptional request data. If supplied then the headers and data from the given Message will be sent with the request.
uidrequest identifier. Use the method 'getRequestUID' for the next suitable UID. UIDs need only be unique in this session.
Returns
the value of argument 'uid'

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