GNUMessenger::KitProtocol Class Reference
[Protocols]

#include <kitprotocol.h>

Inheritance diagram for GNUMessenger::KitProtocol:

[legend]Collaboration diagram for GNUMessenger::KitProtocol:

[legend]List of all members.

Public Member Functions
	KitProtocol (const XMLNode &, ProtocolManager *manager)
const string	screenName ()
virtual void	update ()
	In a non-event based system this call will check the network for incoming data and will call appropriate handlers.
virtual void	login ()
	Initiates the login sequence for this protocol.
virtual void	logout ()
	Sends the protocol the log-out request and disconnects the socket (Network).
virtual bool	sendMessage (const Contact &recipient, const string &message)
	Tries to send a message to a Contact via this protocol.
virtual void	addBuddy (const Contact &c)
virtual void	delBuddy (const Contact &c)
virtual void	newUser ()
virtual void	getPubkey ()
virtual void	customRequest (XMLNode n)
virtual void	handleData (Network *net)
virtual void	handleData (Network *net, const string &buf)
virtual void	connectionError (Network *net, int error)
virtual void	connectedToServer (Network *net)
virtual void	reset ()
	Resets the protocol by disconnecting and reconnecting to the network.

---

Detailed Description

The kit protocol implementation.

The configuration XML looks like this:

 <kit>
  <server host="a.kitserver.com" port="4444" />
  <user username="username" password="secret.password" />
 </kit>
 

Definition at line 50 of file kitprotocol.h.

---

Member Function Documentation

virtual void GNUMessenger::KitProtocol::login (   )  [virtual]

Initiates the login sequence for this protocol. Note: This call in no way guarentees that the login attempt was successful. That information will be relayed by an error callback. Implements GNUMessenger::Protocol.

virtual void GNUMessenger::KitProtocol::reset (   )  [inline, virtual]

Resets the protocol by disconnecting and reconnecting to the network. All configuration settings are re-read. Implements GNUMessenger::Protocol. Definition at line 75 of file kitprotocol.h. {}

virtual bool GNUMessenger::KitProtocol::sendMessage (  const Contact &  recipient, const string &  message )  [virtual]

Tries to send a message to a Contact via this protocol. Parameters: recipient  The intended recipient. message  The text message to send. Note: This call does not mean the contact has recieved the message, that is network dependent and my fail. If a fail should occur, an appropriate error callback will be called. Returns: False if the Contact is not subscribed to this protocol or if the protocol is offline. Implements GNUMessenger::Protocol.

virtual void GNUMessenger::KitProtocol::update (   )  [virtual]

In a non-event based system this call will check the network for incoming data and will call appropriate handlers. Reimplemented from GNUMessenger::Protocol.

---

The documentation for this class was generated from the following file:

• kitprotocol.h

---