ObjXMPP  Check-in [f5739f6ee6]

Overview
Comment:Hide instance variables from the documentation.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: f5739f6ee68fd1709eeddee3b1ea4949bdcd2f249aba555c460001284533c086
User & Date: js on 2012-02-03 10:43:44
Other Links: manifest | tags
Context
2012-02-03
10:54
Allow IDNs for server and not only domain. check-in: 3ae82f03d8 user: js tags: trunk
10:43
Hide instance variables from the documentation. check-in: f5739f6ee6 user: js tags: trunk
10:31
Make the body of a message a property. check-in: edef1e1fbf user: js tags: trunk
Changes

Modified Doxyfile from [c6dec08bef] to [ed269b881b].

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









>
1
2
3
4
5
6
7
8
9
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
IGNORE_PREFIX = XMPP

Modified src/XMPPAuthenticator.h from [e029c909bb] to [0cd7759ddf].

23
24
25
26
27
28
29

30
31
32

33
34
35
36
37
38
39
#import <ObjFW/ObjFW.h>

/**
 * \brief A base class for classes implementing authentication mechanisms
 */
@interface XMPPAuthenticator: OFObject
{

	OFString *authzid;
	OFString *authcid;
	OFString *password;

}

#ifdef OF_HAVE_PROPERTIES
/// The authzid to get authorization for
@property (copy) OFString *authzid;
/// The authcid to authenticate with
@property (copy) OFString *authcid;







>



>







23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#import <ObjFW/ObjFW.h>

/**
 * \brief A base class for classes implementing authentication mechanisms
 */
@interface XMPPAuthenticator: OFObject
{
/// \cond internal
	OFString *authzid;
	OFString *authcid;
	OFString *password;
/// \endcond
}

#ifdef OF_HAVE_PROPERTIES
/// The authzid to get authorization for
@property (copy) OFString *authzid;
/// The authcid to authenticate with
@property (copy) OFString *authcid;

Modified src/XMPPConnection.h from [8496d5899f] to [958c307992].

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
 * \brief A class which abstracts a connection to an XMPP service.
 */
@interface XMPPConnection: OFObject
#ifdef OF_HAVE_OPTONAL_PROTOCOLS
    <OFXMLParserDelegate, OFXMLElementBuilderDelegate>
#endif
{

	id sock;
	OFXMLParser *parser, *oldParser;
	OFXMLElementBuilder *elementBuilder, *oldElementBuilder;
	OFString *username, *password, *server, *resource;
	OFString *privateKeyFile, *certificateFile;
	OFString *domain, *domainToASCII;
	XMPPJID *JID;
	uint16_t port;
	XMPPMulticastDelegate *delegates;
	OFMutableDictionary *callbacks;
	XMPPAuthenticator *authModule;
	BOOL streamOpen;
	BOOL needsSession;
	BOOL encryptionRequired, encrypted;
	unsigned int lastID;

}

#ifdef OF_HAVE_PROPERTIES
@property (copy) OFString *username;
@property (copy) OFString *password;
@property (copy) OFString *server;
@property (copy) OFString *domain;







>















>







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
 * \brief A class which abstracts a connection to an XMPP service.
 */
@interface XMPPConnection: OFObject
#ifdef OF_HAVE_OPTONAL_PROTOCOLS
    <OFXMLParserDelegate, OFXMLElementBuilderDelegate>
#endif
{
/// \cond internal
	id sock;
	OFXMLParser *parser, *oldParser;
	OFXMLElementBuilder *elementBuilder, *oldElementBuilder;
	OFString *username, *password, *server, *resource;
	OFString *privateKeyFile, *certificateFile;
	OFString *domain, *domainToASCII;
	XMPPJID *JID;
	uint16_t port;
	XMPPMulticastDelegate *delegates;
	OFMutableDictionary *callbacks;
	XMPPAuthenticator *authModule;
	BOOL streamOpen;
	BOOL needsSession;
	BOOL encryptionRequired, encrypted;
	unsigned int lastID;
/// \endcond
}

#ifdef OF_HAVE_PROPERTIES
@property (copy) OFString *username;
@property (copy) OFString *password;
@property (copy) OFString *server;
@property (copy) OFString *domain;

Modified src/XMPPExceptions.h from [fa00861fee] to [f066866cc9].

26
27
28
29
30
31
32

33

34
35
36
37
38
39
40
@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, assign) XMPPConnection *connection;
#endif








>

>







26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@class XMPPAuthenticator;

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

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

64
65
66
67
68
69
70

71
72

73
74
75
76
77
78
79
@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, assign) OFString *condition;
/// The descriptive free-form text specified by the stream error
@property (readonly, assign) OFString *reason;







>


>







66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
@end

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

#ifdef OF_HAVE_PROPERTIES
/// The defined error condition specified by the stream error
@property (readonly, assign) OFString *condition;
/// The descriptive free-form text specified by the stream error
@property (readonly, assign) OFString *reason;
113
114
115
116
117
118
119

120
121

122
123
124
125
126
127
128

/**
 * \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, assign) OFString *profile;
/// The string that failed the stringprep profile
@property (readonly, assign) OFString *string;







>


>







117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

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

#ifdef OF_HAVE_PROPERTIES
/// The name of the stringprep profile that did not apply
@property (readonly, assign) OFString *profile;
/// The string that failed the stringprep profile
@property (readonly, assign) OFString *string;
161
162
163
164
165
166
167

168
169

170
171
172
173
174
175
176
@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, assign) OFString *operation;
/// The string that could not be translated
@property (readonly, assign) OFString *string;







>


>







167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
@end

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

#ifdef OF_HAVE_PROPERTIES
/// The IDNA translation operation which failed
@property (readonly, assign) OFString *operation;
/// The string that could not be translated
@property (readonly, assign) OFString *string;
209
210
211
212
213
214
215

216

217
218
219
220
221
222
223
@end

/**
 * \brief An exception indicating authentication failed
 */
@interface XMPPAuthFailedException: XMPPException
{

	OFString *reason;

}

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








>

>







217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
@end

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

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

Modified src/XMPPJID.h from [0a05a907db] to [9a904b032f].

24
25
26
27
28
29
30

31
32
33

34
35
36
37
38
39
40
#import <ObjFW/ObjFW.h>

/**
 * \brief A class for easy handling of JIDs.
 */
@interface XMPPJID: OFObject <OFCopying>
{

	OFString *node;
	OFString *domain;
	OFString *resource;

}

#ifdef OF_HAVE_PROPERTIES
/// The JID's localpart
@property (copy) OFString *node;
/// The JID's domainpart
@property (copy) OFString *domain;







>



>







24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
#import <ObjFW/ObjFW.h>

/**
 * \brief A class for easy handling of JIDs.
 */
@interface XMPPJID: OFObject <OFCopying>
{
/// \cond internal
	OFString *node;
	OFString *domain;
	OFString *resource;
/// \endcond
}

#ifdef OF_HAVE_PROPERTIES
/// The JID's localpart
@property (copy) OFString *node;
/// The JID's domainpart
@property (copy) OFString *domain;

Modified src/XMPPMulticastDelegate.h from [dd96fb9a11] to [e8290add4f].

25
26
27
28
29
30
31

32

33
34
35
36
37
38
39
@class OFDataArray;

/**
 * \brief A class to provide multiple delegates in a single class
 */
@interface XMPPMulticastDelegate: OFObject
{

	OFDataArray *delegates;

}

/**
 * Adds a delegate to the set of managed delegates
 *
 * \param delegate The delegate to add
 */







>

>







25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@class OFDataArray;

/**
 * \brief A class to provide multiple delegates in a single class
 */
@interface XMPPMulticastDelegate: OFObject
{
/// \cond internal
	OFDataArray *delegates;
/// \endcond
}

/**
 * Adds a delegate to the set of managed delegates
 *
 * \param delegate The delegate to add
 */

Modified src/XMPPRoster.h from [acf1cf5003] to [0285d089da].

63
64
65
66
67
68
69

70
71
72

73
74
75
76
77
78
79
 * \brief A class implementing roster related functionality
 */
@interface XMPPRoster: OFObject
#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
    <XMPPConnectionDelegate>
#endif
{

	XMPPConnection *connection;
	OFMutableDictionary *rosterItems;
	XMPPMulticastDelegate *delegates;

}

/**
 * Initializes an already allocated XMPPRoster
 *
 * \param connection The connection roster related stanzas
 *	  are send and received over







>



>







63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 * \brief A class implementing roster related functionality
 */
@interface XMPPRoster: OFObject
#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
    <XMPPConnectionDelegate>
#endif
{
/// \cond internal
	XMPPConnection *connection;
	OFMutableDictionary *rosterItems;
	XMPPMulticastDelegate *delegates;
/// \endcond
}

/**
 * Initializes an already allocated XMPPRoster
 *
 * \param connection The connection roster related stanzas
 *	  are send and received over

Modified src/XMPPRosterItem.h from [3813168f1c] to [109ad297e3].

20
21
22
23
24
25
26



27
28

29
30
31
32

33
34
35
36
37
38
39
 * POSSIBILITY OF SUCH DAMAGE.
 */

#import <ObjFW/ObjFW.h>

@class XMPPJID;




@interface XMPPRosterItem: OFObject
{

	XMPPJID *JID;
	OFString *name;
	OFString *subscription;
	OFArray *groups;

}

#ifdef OF_HAVE_PROPERTIES
@property (copy) XMPPJID *JID;
@property (copy) OFString *name;
@property (copy) OFString *subscription;
@property (copy) OFArray *groups;







>
>
>


>




>







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
 * POSSIBILITY OF SUCH DAMAGE.
 */

#import <ObjFW/ObjFW.h>

@class XMPPJID;

/**
 * \brief A class for representing an item in the roster.
 */
@interface XMPPRosterItem: OFObject
{
/// \cond intenral
	XMPPJID *JID;
	OFString *name;
	OFString *subscription;
	OFArray *groups;
/// \endcond
}

#ifdef OF_HAVE_PROPERTIES
@property (copy) XMPPJID *JID;
@property (copy) OFString *name;
@property (copy) OFString *subscription;
@property (copy) OFArray *groups;

Modified src/XMPPSCRAMAuth.h from [f5357d1fa6] to [f6a39a6afe].

25
26
27
28
29
30
31

32
33
34
35
36
37
38
39

40
41
42
43
44
45
46
#import "XMPPConnection.h"

/**
 * \brief A class to authenticate using SCRAM
 */
@interface XMPPSCRAMAuth: XMPPAuthenticator
{

	Class hashType;
	OFString *cNonce;
	OFString *GS2Header;
	OFString *clientFirstMessageBare;
	OFDataArray *serverSignature;
	XMPPConnection *connection;
	BOOL plusAvailable;
	BOOL authenticated;

}

/**
 * Creates a new autoreleased XMPPSCRAMAuth with an authcid and password.
 *
 * \param authcid The authcid to authenticate with
 * \param password The password to authenticate with







>








>







25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
#import "XMPPConnection.h"

/**
 * \brief A class to authenticate using SCRAM
 */
@interface XMPPSCRAMAuth: XMPPAuthenticator
{
/// \cond internal
	Class hashType;
	OFString *cNonce;
	OFString *GS2Header;
	OFString *clientFirstMessageBare;
	OFDataArray *serverSignature;
	XMPPConnection *connection;
	BOOL plusAvailable;
	BOOL authenticated;
/// \endcond
}

/**
 * Creates a new autoreleased XMPPSCRAMAuth with an authcid and password.
 *
 * \param authcid The authcid to authenticate with
 * \param password The password to authenticate with

Modified src/XMPPStanza.h from [eb4f4f5610] to [ecb78e970b].

26
27
28
29
30
31
32

33
34
35
36

37
38
39
40
41
42
43
@class XMPPJID;

/**
 * \brief A class describing an XMPP Stanza.
 */
@interface XMPPStanza: OFXMLElement
{

	XMPPJID *from;
	XMPPJID *to;
	OFString *type;
	OFString *ID;

}

#ifdef OF_HAVE_PROPERTIES
/// The value of the stanza's from attribute
@property (copy) XMPPJID *from;
/// The value of the stanza's to attribute
@property (copy) XMPPJID *to;







>




>







26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@class XMPPJID;

/**
 * \brief A class describing an XMPP Stanza.
 */
@interface XMPPStanza: OFXMLElement
{
/// \cond internal
	XMPPJID *from;
	XMPPJID *to;
	OFString *type;
	OFString *ID;
/// \endcond
}

#ifdef OF_HAVE_PROPERTIES
/// The value of the stanza's from attribute
@property (copy) XMPPJID *from;
/// The value of the stanza's to attribute
@property (copy) XMPPJID *to;