DEPRECATED: Diffusion iOS Classic API  5.9.4
 All Data Structures Files Functions Variables Enumerations Enumerator Properties Macros Pages
DFServiceTopicError.h
1 //
2 // DFServiceTopicError.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 @class DFTopicHandler;
11 
12 #define ERROR_RESPONSE_TYPE @"!ERR"
13 
14 typedef enum {
15  SRV, /**< A problem has occurred whilst executing the service at the server */
16  DUP, /**< Duplicate request identifier */
17  TIM, /**< Request timed out */
18  INV, /**< Request invalid */
19  USR, /**< Error reported by user written service handler */
20  UNKNOWN /**< Unknown error type */
21 } DFServiceErrorType;
22 
23 /**
24  * Encapsulates the details of a Service Topic error
25  */
26 @interface DFServiceTopicError : NSObject
27 
28 
29 
30 @property(weak, nonatomic,readonly) DFServiceTopicHandler *handler; /**< Returns the handler that notified the error */
31 @property(nonatomic,readonly) NSString *requestID; /**< Returns the request identifier of the failed service request */
32 @property(nonatomic,readonly) NSString *errorMessage; /**< Returns the error message */
33 @property(nonatomic,readonly) NSString *exceptionMessage; /**< an exception message or null if no exception message is available */
34 @property(nonatomic,readonly) NSString *additionalDetails; /**< additional details if any are available , otherwise null */
35 @property(nonatomic,readonly) DFServiceErrorType errorType; /**< the error type */
36 
37 @end
38