XMPPConnection class documentation

Authors

Generated by builder

Software documentation for the XMPPConnection class

XMPPConnection : ETXMLNullHandler

Declared in:
XMPPConnection.h
Conforms to:
XMPPInfoQueryStanzaHandler
The XMPPConnection class represents a connection to an XMPP server. It is the root parser owner. All XML received from the server is parsed by this class (or delegated to others by this class). All sending of XML data goes via this class.

Instance Variables

Method summary

XMPPSend: 

- (void) XMPPSend: (NSString*)buffer;
Send the passed XML to the server.

connectToJabberServer: withJID: password: 

- (void) connectToJabberServer: (NSString*)jabberServer withJID: (JID*)aJID password: (NSString*)password;
Connect to the specified Jabber server as the specified user, with the given password. This needs changing for cases where the server is not that specified by the client's JID.

disconnect 

- (void) disconnect;
Disconnect from the Jabber server.

dispatcher 

- (XMPPDispatcher*) dispatcher;
Returns the dispatcher associated with the connection.

initWithAccount: 

- (id) initWithAccount: (id)anAccount;
Initialise the connection for a specified account.

isConnected 

- (BOOL) isConnected;
Returns YES if connected to the server.

nextMessageID 

- (NSString*) nextMessageID;
Returns a new connection-unique ID to be used with iq set/get stanzas.

reconnectToJabberServer 

- (void) reconnectToJabberServer;
Reconnect after disconnection.

server 

- (NSString*) server;
Returns the server name.

setPresenceDisplay: 

- (void) setPresenceDisplay: (id<XMPPPresenceDisplay,NSObject>)_display;
Sets the UI component used to display the presence. This should definitely be replaced with a notification based system.

setStatus: withMessage: 

- (void) setStatus: (unsigned char)aStatus withMessage: (NSString*)aMessage;
Set the current status.

xmlWriter 

- (ETXMLSocketWriter*) xmlWriter;
Returns the XML writer which can be used to send XML to the stream.



Instance Variables for XMPPConnection Class

account

@protected id account;
Description forthcoming.

dispatcher

@protected XMPPDispatcher* dispatcher;
Description forthcoming.

keepalive

@protected NSTimer* keepalive;
Description forthcoming.

messageID

@protected unsigned int messageID;
Description forthcoming.

pass

@protected NSString* pass;
Description forthcoming.

presenceDisplay

@protected id presenceDisplay;
Description forthcoming.

res

@protected NSString* res;
Description forthcoming.

roster

@protected XMPPRoster* roster;
Description forthcoming.

server

@protected NSString* server;
Description forthcoming.

serverHost

@protected NSString* serverHost;
Description forthcoming.

sessionID

@protected NSString* sessionID;
Description forthcoming.

socket

@protected ETSocket* socket;
Description forthcoming.

streamFeatures

@protected NSDictionary* streamFeatures;
Description forthcoming.

unsentBuffer

@protected NSMutableString* unsentBuffer;
Description forthcoming.

user

@protected NSString* user;
Description forthcoming.

xmlLog

@protected Class xmlLog;
Description forthcoming.

xmlWriter

@protected ETXMLSocketWriter* xmlWriter;
Description forthcoming.