ObjXMPP  Check-in [528b341cdc]

Overview
Comment:Document the exceptions
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 528b341cdcfe93513ba59f37026d21a62ce9e8f67737b52ef8631010e1761773
User & Date: florob@babelmonkeys.de on 2012-01-29 23:39:12
Other Links: manifest | tags
Context
2012-01-30
13:35
Remove the roster delegate if it gets deallocated. check-in: 840e61d391 user: js tags: trunk
2012-01-29
23:39
Document the exceptions check-in: 528b341cdc user: florob@babelmonkeys.de tags: trunk
2012-01-28
00:43
Decouple XMPPRoster and XMPPConnection check-in: 128dcb8343 user: florob@babelmonkeys.de tags: trunk
Changes

Modified Doxyfile from [ca01687d67] to [c6dec08bef].

1
2
3
4
5
6
7

1
2
3
4
5
6
7
8







+
PROJECT_NAME = "ObjXMPP"
OUTPUT_DIRECTORY = docs/
INPUT = src
FILE_PATTERNS = *.h *.m
HTML_OUTPUT = .
GENERATE_LATEX = NO
HIDE_UNDOC_CLASSES = YES
PREDEFINED = OF_HAVE_PROPERTIES

Modified src/XMPPExceptions.h from [51ba3fe543] to [d04f1172ae].

21
22
23
24
25
26
27



28
29
30
31
32
33

34
35
36








37
38










39
40


41
42
43



44
45
46
47
48
49
50

51

52
53
54









55
56
57
58













59
60
61
62




63
64
65
66




67
68
69
70
71
72
73

74



75
76









77
78

79
80










81
82

83
84

85
86
87
88



89
90
91
92
93
94
95

96



97
98









99
100

101
102










103
104

105
106

107
108
109
110



111
112
113
114
115
116

117
118
119








120
121
122











123
124
125



126
127
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

50
51
52
53
54
55
56
57
58
59
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91



92
93
94
95
96
97
98
99
100
101
102
103
104
105



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

141
142
143
144
145
146
147
148
149
150
151
152
153
154

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

189
190
191
192
193
194
195
196
197
198
199
200
201
202

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232


233
234
235
236
237
238
239
240
241
242
243
244


245
246
247
248
249







+
+
+






+



+
+
+
+
+
+
+
+

-
+
+
+
+
+
+
+
+
+
+

-
+
+



+
+
+







+

+



+
+
+
+
+
+
+
+
+

-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+

-
-
-
+
+
+
+




+
+
+
+







+
-
+
+
+


+
+
+
+
+
+
+
+
+

-
+


+
+
+
+
+
+
+
+
+
+

-
+


+




+
+
+







+
-
+
+
+


+
+
+
+
+
+
+
+
+

-
+


+
+
+
+
+
+
+
+
+
+

-
+


+




+
+
+






+



+
+
+
+
+
+
+
+

-
-
+
+
+
+
+
+
+
+
+
+
+

-
-
+
+
+


 */

#import <ObjFW/ObjFW.h>

@class XMPPConnection;
@class XMPPAuthenticator;

/**
 * \brief A base class for XMPP related exceptions
 */
@interface XMPPException: OFException
{
	XMPPConnection *connection;
}

#ifdef OF_HAVE_PROPERTIES
/// The connection the exception relates to
@property (readonly, nonatomic) XMPPConnection *connection;
#endif

/**
 * Creates a new XMPPException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection that received the data responsible
 *	  for this exception
 * \return A new XMPPException
 */
+ exceptionWithClass: (Class)class_
	  connection: (XMPPConnection*)conn;
	  connection: (XMPPConnection*)connection;

/**
 * Initializes an already allocated XMPPException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection that received the data responsible
 *	  for this exception
 * \return An initialized XMPPException
 */
- initWithClass: (Class)class_
     connection: (XMPPConnection*)conn;
     connection: (XMPPConnection*)connection;

- (XMPPConnection*)connection;
@end

/**
 * \brief An exception indicating a stream error was received
 */
@interface XMPPStreamErrorException: XMPPException
{
	OFString *condition;
	OFString *reason;
}

#ifdef OF_HAVE_PROPERTIES
/// The defined error condition specified by the stream error
@property (readonly, nonatomic) OFString *condition;
/// The descriptive free-form text specified by the stream error
@property (readonly, nonatomic) OFString *reason;
#endif

/**
 * Creates a new XMPPStreamErrorException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection that received the stream error
 * \param condition The defined error condition specified by the stream error
 * \param reason The descriptive free-form text specified by the stream error
 * \return A new XMPPStreamErrorException
 */
+ exceptionWithClass: (Class)class_
	  connection: (XMPPConnection*)conn
     condition: (OFString*)condition_
	reason: (OFString*)reason_;
	  connection: (XMPPConnection*)connection
	   condition: (OFString*)condition
	      reason: (OFString*)reason;

/**
 * Initializes an already allocated XMPPStreamErrorException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection that received the stream error
 * \param condition The defined error condition specified by the stream error
 * \param reason The descriptive free-form text specified by the stream error
 * \return An initialized XMPPStreamErrorException
 */
- initWithClass: (Class)class_
     connection: (XMPPConnection*)conn
      condition: (OFString*)condition_
	 reason: (OFString*)reason_;
     connection: (XMPPConnection*)connection
      condition: (OFString*)condition
	 reason: (OFString*)reason;

- (OFString*)condition;
- (OFString*)reason;
@end

/**
 * \brief An exception indicating a stringprep profile
 *	  did not apply to a string
 */
@interface XMPPStringPrepFailedException: XMPPException
{
	OFString *profile;
	OFString *string;
}

#ifdef OF_HAVE_PROPERTIES
/// The name of the stringprep profile that did not apply
@property (readonly, nonatomic) OFString *profile, *string;
@property (readonly, nonatomic) OFString *profile;
/// The string that failed the stringprep profile
@property (readonly, nonatomic) OFString *string;
#endif

/**
 * Creates a new XMPPStringPrepFailedException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection the string relates to
 * \param profile The name of the stringprep profile that did not apply
 * \param string The string that failed the stringprep profile
 * \return A new XMPPStringPrepFailedException
 */
+ exceptionWithClass: (Class)class_
	  connection: (XMPPConnection*)conn
	  connection: (XMPPConnection*)connection
	     profile: (OFString*)profile
	      string: (OFString*)string;

/**
 *  Initializes an already allocated XMPPStringPrepFailedException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection the string relates to
 * \param profile The name of the stringprep profile that did not apply
 * \param string The string that failed the stringprep profile
 * \return An initialized XMPPStringPrepFailedException
 */
- initWithClass: (Class)class_
     connection: (XMPPConnection*)conn
     connection: (XMPPConnection*)connection
	profile: (OFString*)profile
	 string: (OFString*)string;

- (OFString*)profile;
- (OFString*)string;
@end

/**
 * \brief An exception indicating IDNA translation of a string failed
 */
@interface XMPPIDNATranslationFailedException: XMPPException
{
	OFString *operation;
	OFString *string;
}

#ifdef OF_HAVE_PROPERTIES
/// The IDNA translation operation which failed
@property (readonly, nonatomic) OFString *operation, *string;
@property (readonly, nonatomic) OFString *operation;
/// The string that could not be translated
@property (readonly, nonatomic) OFString *string;
#endif

/**
 * Creates a new XMPPIDNATranslationFailedException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection the string relates to
 * \param operation The name of the stringprep profile that did not apply
 * \param string The string that could not be translated
 * \return A new XMPPIDNATranslationFailedException
 */
+ exceptionWithClass: (Class)class_
	  connection: (XMPPConnection*)conn
	  connection: (XMPPConnection*)connection
	   operation: (OFString*)operation
	      string: (OFString*)string;

/**
 * Initializes an already allocated XMPPIDNATranslationFailedException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection the string relates to
 * \param operation The name of the stringprep profile that did not apply
 * \param string The string that could not be translated
 * \return An initialized XMPPIDNATranslationFailedException
 */
- initWithClass: (Class)class_
     connection: (XMPPConnection*)conn
     connection: (XMPPConnection*)connection
      operation: (OFString*)operation
	 string: (OFString*)string;

- (OFString*)operation;
- (OFString*)string;
@end

/**
 * \brief An exception indicating authentication failed
 */
@interface XMPPAuthFailedException: XMPPException
{
	OFString *reason;
}

#ifdef OF_HAVE_PROPERTIES
/// The reason the authentication failed
@property (readonly, nonatomic) OFString *reason;
#endif

/**
 * Creates a new XMPPAuthFailedException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection that could not be authenticated
 * \param reason The reason the authentication failed
 * \return A new XMPPAuthFailedException
 */
+ exceptionWithClass: (Class)class_
	  connection: (XMPPConnection*)conn
	      reason: (OFString*)reason_;
	  connection: (XMPPConnection*)connection
	      reason: (OFString*)reason;

/**
 * Initializes an already allocated XMPPAuthFailedException
 *
 * \param class_ The class of the object which caused the exception
 * \param connection The connection that could not be authenticated
 * \param reason The reason the authentication failed
 * \return An initialized XMPPAuthFailedException
 */
- initWithClass: (Class)class_
     connection: (XMPPConnection*)conn
	 reason: (OFString*)reason_;
     connection: (XMPPConnection*)connection
	 reason: (OFString*)reason;

- (OFString*)reason;
@end