DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
DFServiceTopicDelegate.h
1 //
2 // DFServiceTopicDelegate.h
3 // DiffusionTransport
4 //
5 // Created by Martin Cowie on 23/12/2011 - Diffusion 5.9.4_01
6 // Copyright (c) 2013 Push Technology Ltd. All rights reserved.
7 //
8 
9 #import "DFServiceTopicResponse.h"
10 #import "DFServiceTopicError.h"
11 
12 /**
13  * Listener for responses from a Service Topic.
14  *<P>
15  * A Service Topic is one that provides request/response capability
16  * (see ServiceTopicData). When a Client subscribes to a Service Topic
17  * then a Topic Load Message will be received by the Client that indicates
18  * that it is a TopicMessage#isServiceLoad() Service Load Message.
19  * In response to such a Message the Client application should create a
20  * ServiceTopicHandler using the Client connection
21  * ExternalClientConnection#createServiceTopicHandler(TopicMessage, ServiceTopicListener) method
22  * and declaring a listener of this type to receive all responses and
23  * notifications from the Topic.
24  *
25  * @author pwalsh - created 1 Dec 2011
26  * @since 4.1
27  */
28 @protocol DFServiceTopicDelegate <NSObject>
29 
30 /**
31  * Notifies a response from a service request.
32  * <P>
33  * This will return a response from a previous call of
34  * ServiceTopicHandler#request(String, TopicMessage).
35  *
36  * @param responseDetails encapsulates all details of the response.
37  */
38 -(void)serviceResponse:(DFServiceTopicResponse*)responseDetails;
39 
40 /**
41  * Notifies an error on a service request.
42  * <P>
43  * This would indicate that a previous call to
44  * ServiceTopicHandler#request(String, TopicMessage) has failed
45  * for some reason at the server.
46  *
47  * @param errorDetails encapsulates details of the error
48  */
49 -(void)serviceError:(DFServiceTopicError*)errorDetails;
50 
51 @end