ObjXMPP  Check-in [baa634a6f1]

Overview
Comment:Add some documentation
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: baa634a6f17a8f6b1b64c598785cb7f38d44ead9b8c80963621b1c169f60aad3
User & Date: florob@babelmonkeys.de on 2011-02-12 00:04:19
Other Links: manifest | tags
Context
2011-02-12
00:10
Add clean target to Makefile check-in: 99c48f991e user: florob@babelmonkeys.de tags: trunk
00:04
Add some documentation check-in: baa634a6f1 user: florob@babelmonkeys.de tags: trunk
2011-02-11
01:25
Respectively do Nameprep/SASLPrep on domain name and password check-in: 3dcaf032f2 user: florob@babelmonkeys.de tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Added Doxyfile version [ca01687d67].

Modified src/XMPPConnection.h from [7ed5d921f4] to [6a8017ad60].

︙
11
12
13
14
15
16
17



18
19
20
21
22




23




24




25




26




27




28
29
30
31
32
33
34
35
36
37
38
39
40



41




42






43
44

11
12
13
14
15
16
17
18
19
20
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








+
+
+





+
+
+
+

+
+
+
+

+
+
+
+

+
+
+
+

+
+
+
+

+
+
+
+













+
+
+

+
+
+
+

+
+
+
+
+
+



      didReceiveIQ: (XMPPIQ*)iq;
-   (void)connection: (XMPPConnection*)conn
  didReceivePresence: (XMPPPresence*)pres;
-  (void)connection: (XMPPConnection*)conn
  didReceiveMessage: (XMPPMessage*)msg;
@end

/**
 * \brief A class that abstracts a connection to an XMPP service
 */
@interface XMPPConnection: OFObject <OFXMLElementBuilderDelegate>
{
	OFTCPSocket *sock;
	OFXMLParser *parser;
	OFXMLElementBuilder *elementBuilder;

	/**
	 * The username (local part of the JID) to connect with
	 */
	OFString *username;

	/**
	 * The password to connect with
	 */
	OFString *password;

	/**
	 * The server to connect to
	 */
	OFString *server;

	/**
	 * The resource to connect with
	 */
	OFString *resource;

	/**
	 * The port to connect to
	 */
	short port;

	/**
	 * Whether to use TLS
	 */
	BOOL useTLS;
	id <XMPPConnectionDelegate> delegate;
	OFMutableArray *mechanisms;
}

@property (copy) OFString *username;
@property (copy) OFString *password;
@property (copy) OFString *server;
@property (copy) OFString *resource;
@property (assign) short port;
@property (assign) BOOL useTLS;
@property (retain) id <XMPPConnectionDelegate> delegate;

/**
 * Connects to the XMPP service
 */
- (void)connect;

/**
 * Starts a loop handling incomming data
 */
- (void)handleConnection;

/**
 * Sends a OFXMLElement (usually a XMPPStanza)
 *
 * \param elem The element to send
 */
- (void)sendStanza: (OFXMLElement*)elem;
@end

Modified src/XMPPStanza.h from [ba0ddf499e] to [1d12631089]. 

1
2



3
4



5




6




7




8
9
10
11
12
13
14
15






16








17
18









19
20










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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
250
251
252
253
254
255
256
257
258
259




260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292




293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333



+
+
+


+
+
+

+
+
+
+

+
+
+
+

+
+
+
+








+
+
+
+
+
+

+
+
+
+
+
+
+
+

-
+
+
+
+
+
+
+
+
+

-
+
+
+
+
+
+
+
+
+
+

-
-
+
+
+
+
+
+
+
+
+


+
+
+
+
+
+

+
+
+
+
+
+
+
+

-
+
+
+
+
+
+
+
+
+

-
+
+
+
+
+
+
+
+
+
+

-
-
+
+
+
+
+
+
+
+
+



+
+
+




+
+
+
+
+
+
+
-
-
+
+

+
+
+
+
+
+
+
-
-
+
+


+
+
+




+
+
+
+
+

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

+
+
+
+
+

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

+
+
+
+
+



+
+
+




+
+
+
+
+

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

+
+
+
+
+

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

+
+
+
+
+

+
+
+
+
+
+

+
+
+
+
+
+



#import <ObjFW/ObjFW.h>

/**
 * \brief A class describing a XMPP Stanza
 */
@interface XMPPStanza: OFXMLElement
{
	/**
	 * The value of the stanza's from attribute
	 */
	OFString *from;

	/**
	 * The value of the stanza's to attribute
	 */
	OFString *to;

	/**
	 * The value of the stanza's type attribute
	 */
	OFString *type;

	/**
	 * The value of the stanza's id attribute
	 */
	OFString *ID;
}

@property (copy) OFString *from;
@property (copy) OFString *to;
@property (copy) OFString *type;
@property (copy) OFString *ID;

/**
 * Creates a new XMPPStanza with a certain name
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \return A new autoreleased XMPPStanza
 */
+ stanzaWithName: (OFString*)name;

/**
 * Creates a new XMPPStanza with a certain name and type
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \param type The value for the stanza's type attribute
 * \return A new autoreleased XMPPStanza
 */
+ stanzaWithName: (OFString*)name
	    type: (OFString*)type_;
	    type: (OFString*)type;

/**
 * Creates a new XMPPStanza with a certain name and id
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPStanza
 */
+ stanzaWithName: (OFString*)name
	      ID: (OFString*)ID_;
	      ID: (OFString*)ID;

/**
 * Creates a new XMPPStanza with a certain name, type and id
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPStanza
 */
+ stanzaWithName: (OFString*)name
	    type: (OFString*)type_
	      ID: (OFString*)ID_;
	    type: (OFString*)type
	      ID: (OFString*)ID;

/**
 * Creates a new XMPPStanza from a OFXMLElement
 *
 * \param elem The element to base the XMPPStanza on
 * \return A new autoreleased XMPPStanza
 */
+ stanzaWithElement: (OFXMLElement*)elem;

/**
 * Initializes an already allocated XMPPStanza with a certain name
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \return A initialized XMPPStanza
 */
- initWithName: (OFString*)name;

/**
 * Initializes an already allocated XMPPStanza with a certain name and type
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \param type The value for the stanza's type attribute
 * \return A initialized XMPPStanza
 */
- initWithName: (OFString*)name
	    type: (OFString*)type_;
	    type: (OFString*)type;

/**
 * Initializes an already allocated XMPPStanza with a certain name and id
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPStanza
 */
- initWithName: (OFString*)name
	      ID: (OFString*)ID_;
	      ID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPStanza with a certain name, type and id
 *
 * \param name The stanza's name (one of iq, message or presence)
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPStanza
 */
- initWithName: (OFString*)name
	    type: (OFString*)type_
	      ID: (OFString*)ID_;
	    type: (OFString*)type
	      ID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPStanza based on a OFXMLElement
 *
 * \param elem The element to base the XMPPStanza on
 * \return A initialized XMPPStanza
 */
- initWithElement: (OFXMLElement*)elem;
@end

/**
 * \brief A class describing a IQ stanza
 */
@interface XMPPIQ: XMPPStanza
{
}

/**
 * Creates a new XMPPIQ with a certain type and id
 *
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPIQ
 */
+ IQWithType: (OFString*)type_
	  ID: (OFString*)ID_;
+ IQWithType: (OFString*)type
	  ID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPIQ with a certain type and id
 *
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPIQ
 */
- initWithType: (OFString*)type_
	    ID: (OFString*)ID_;
- initWithType: (OFString*)type
	    ID: (OFString*)ID;
@end

/**
 * \brief A class describing a message stanza
 */
@interface XMPPMessage: XMPPStanza
{
}

/**
 * Creates a new XMPPMessage
 *
 * \return A new autoreleased XMPPMessage
 */
+ message;

/**
 * Creates a new XMPPMessage with a certain id
 *
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPMessage
 */
+ messageWithID: (OFString*)ID_;
+ messageWithType: (OFString*)type_;
+ messageWithType: (OFString*)type_
	       ID: (OFString*)ID_;
+ messageWithID: (OFString*)ID;

/**
 * Creates a new XMPPMessage with a certain type
 *
 * \param type The value for the stanza's type attribute
 * \return A new autoreleased XMPPMessage
 */
+ messageWithType: (OFString*)type;

/**
 * Creates a new XMPPMessage with a certain type and id
 *
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPMessage
 */
+ messageWithType: (OFString*)type
	       ID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPMessage
 *
 * \return A initialized XMPPMessage
 */
- init;

/**
 * Initializes an already allocated XMPPMessage with a certain id
 *
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPMessage
 */
- initWithID: (OFString*)ID_;
- initWithType: (OFString*)type_;
- initWithType: (OFString*)type_
	    ID: (OFString*)ID_;
- initWithID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPMessage with a certain type
 *
 * \param type The value for the stanza's type attribute
 * \return A initialized XMPPMessage
 */
- initWithType: (OFString*)type;

/**
 * Initializes an already allocated XMPPMessage with a certain type and id
 *
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPMessage
 */
- initWithType: (OFString*)type
	    ID: (OFString*)ID;

/**
 * Adds a body element to the XMPPMessage
 *
 * \param body The text content of the body element
 */
- (void)addBody: (OFString*)body;
@end

/**
 * \brief A class describing a presence stanza
 */
@interface XMPPPresence: XMPPStanza
{
}

/**
 * Creates a new XMPPPresence
 *
 * \return A new autoreleased XMPPPresence
 */
+ presence;

/**
 * Creates a new XMPPPresence with a certain id
 *
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPPresence
 */
+ presenceWithID: (OFString*)ID_;
+ presenceWithType: (OFString*)type_;
+ presenceWithType: (OFString*)type_
		ID: (OFString*)ID_;
+ presenceWithID: (OFString*)ID;

/**
 * Creates a new XMPPPresence with a certain type
 *
 * \param type The value for the stanza's type attribute
 * \return A new autoreleased XMPPPresence
 */
+ presenceWithType: (OFString*)type;

/**
 * Creates a new XMPPPresence with a certain type and id
 *
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A new autoreleased XMPPPresence
 */
+ presenceWithType: (OFString*)type
		ID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPPresence
 *
 * \return A initialized XMPPPresence
 */
- init;

/**
 * Initializes an already allocated XMPPPresence with a certain id
 *
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPPresence
 */
- initWithID: (OFString*)ID_;
- initWithType: (OFString*)type_;
- initWithType: (OFString*)type_
	    ID: (OFString*)ID_;
- initWithID: (OFString*)ID;

/**
 * Initializes an already allocated XMPPPresence with a certain type
 *
 * \param type The value for the stanza's type attribute
 * \return A initialized XMPPPresence
 */
- initWithType: (OFString*)type;

/**
 * Initializes an already allocated XMPPPresence with a certain type and id
 *
 * \param type The value for the stanza's type attribute
 * \param ID The value for the stanza's id attribute
 * \return A initialized XMPPPresence
 */
- initWithType: (OFString*)type
	    ID: (OFString*)ID;

/**
 * Adds a show element to the presence stanza
 *
 * \param show The text content of the show element
 */
- (void)addShow: (OFString*)show;

/**
 * Adds a status element to the presence stanza
 *
 * \param status The text content of the status element
 */
- (void)addStatus: (OFString*)status;

/**
 * Adds a priority element to the presence stanza
 *
 * \param priority The text content of the priority element
 */
- (void)addPriority: (int8_t)priority;
@end