kopete/protocols/messenger/libpapillon

Papillon::LoginTask

Papillon::LoginTask Class Reference

#include <Papillon/Tasks/LoginTask>

Inheritance diagram for Papillon::LoginTask:

[legend]

List of all members.

Detailed Description

First you create the Login Task after you set login information in the Client.

 LoginTask *login = new LoginTask( connection->rootTask() );
 connect(login, SIGNAL(finished(Papillon::Task*)), ...);
 connect(login, SIGNAL(redirection(const QString &, quint16)), ...);
 login->go();

Use success() to check if the login was successful.

Use loginState() to check for the error if the login wasn't successful.

Author:: Michaël Larouche <larouche@kde.org>

Definition at line 43 of file logintask.h.


Public Types
enum	LoginState { StateVersion, StateCVR, StateTweenerInvite, StateTweenerConfirmed, StateFinish, StateError, StateBadPassword, StateRedirection }
Signals
void	redirection (const QString &server, quint16 port)
Public Member Functions
LoginState	loginState () const
	LoginTask (Papillon::Task *parent)
virtual bool	take (Papillon::NetworkMessage *networkMessage)
virtual	~LoginTask ()
Protected Member Functions
virtual bool	forMe (Papillon::NetworkMessage *networkMessage) const
virtual void	onGo ()

Member Enumeration Documentation

enum Papillon::LoginTask::LoginState

Current state of the login process.

Enumerator:

StateVersion	Begin state, sending the version command.
StateCVR	Sending the CVR command.
StateTweenerInvite	Ask for the tweener ticket.
StateTweenerConfirmed	Now confirm the tweener.
StateFinish	Login was sucessful.
StateError	A unknow error occurred.
StateBadPassword	Nexus service returned a bad passport error.
StateRedirection	Login has requested redirection.

Definition at line 50 of file logintask.h.

Constructor & Destructor Documentation

Papillon::LoginTask::LoginTask ( Papillon::Task * parent ) [explicit]

Create a new Login Task.

Parameters:

parent

parent Task

Definition at line 47 of file logintask.cpp.

Papillon::LoginTask::~LoginTask ( ) [virtual]

d-tor (duh)

Definition at line 52 of file logintask.cpp.

Member Function Documentation

bool Papillon::LoginTask::forMe ( Papillon::NetworkMessage * networkMessage ) const [protected, virtual]

Inherited from Task.

Helper method to check if the NetworkMessage is for us.

Parameters:

networkMessage

give NetworkMessage.

Returns:: true if the NetworkMessage is for us.

Reimplemented from Papillon::Task.

Definition at line 143 of file logintask.cpp.

LoginTask::LoginState Papillon::LoginTask::loginState ( ) const

Get the current state of the Login Task.

Returns:: the current LoginState.

Definition at line 57 of file logintask.cpp.

void Papillon::LoginTask::onGo ( ) [protected, virtual]

Inherited from Task.

Start the login process.

Reimplemented from Papillon::Task.

Definition at line 155 of file logintask.cpp.

void Papillon::LoginTask::redirection	(	const QString &	server,
		quint16	port
	)			`[signal]`

Emitted when the login need to redirect to another server.

Resulting slot should close the notification connection, connect to the new one and recreate a new Login Task.

bool Papillon::LoginTask::take ( Papillon::NetworkMessage * networkMessage ) [virtual]

Inherited from Task.

Proceed the given networkMessage according to the current LoginState. Move to the next login step if required.

Parameters:

networkMessage

given NetworkMessage.

Returns:: true if we proceed this networkMessage.

Reimplemented from Papillon::Task.

Definition at line 62 of file logintask.cpp.

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

kopete/protocols/messenger/libpapillon

Papillon::LoginTask Class Reference

Detailed Description

Public Types

Signals

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kopete/protocols/messenger/libpapillon

kdenetwork