Home · Modules · Classes · Namespaces · Functions

QxtPop3Reply Class Reference
[QxtNetwork module]

The QxtPop3Reply class encapsulates the reply to an asynchronous POP3 command. More...

    #include <QxtPop3Reply>

Inherits QObject.

Inherited by QxtPop3ListReply, QxtPop3RetrReply, and QxtPop3StatReply.

Public Types

Public Functions

Signals

Additional Inherited Members


Detailed Description

The QxtPop3Reply class encapsulates the reply to an asynchronous POP3 command.

This isn't a class that is to be instanciated or subclassed by client code. You get pointers to QxtPop3Reply (or subclasses thereof) objects via QxtPop3 methods implementing the POP3 commands, and you can use them to:

The QxtPop3Reply object is managed by the QxtPop3 object, and is deleted with it. If the QxtPop3 object is long-lived, you can do some cleaning-up with its QxtPop3::clearReplies() method, for example after closing a connection to the server.

See also QxtPop3.


Member Type Documentation

enum QxtPop3Reply::ReturnCode

Return codes for the finished() signal, indicating how the reply finished.

ConstantValueDescription
QxtPop3Reply::OK0Success, the result, if any, is available.
QxtPop3Reply::Timeout1The reply timed out.
QxtPop3Reply::Failed2The reply failed.
QxtPop3Reply::Aborted3The reply was cancelled.

enum QxtPop3Reply::Status

Status of the reply.

ConstantValueDescription
QxtPop3Reply::Pending0The reply is queued and waits to be run.
QxtPop3Reply::Running1The repy is currently being run.
QxtPop3Reply::Completed2The reply has completed, the result, if any, is available.
QxtPop3Reply::Timedout3The reply timed out.
QxtPop3Reply::Error4An error occured.

enum QxtPop3Reply::Type

Type of POP3 command, as returned by type().

ConstantValueDescription
QxtPop3Reply::Auth0AUTH POP3 command.
QxtPop3Reply::Quit1QUIT POP3 command.
QxtPop3Reply::Stat2STAT POP3 command.
QxtPop3Reply::List3LIST POP3 command.
QxtPop3Reply::Reset4RSET POP3 command.
QxtPop3Reply::Dele5DELE POP3 command.
QxtPop3Reply::Retr6RETR POP3 command.
QxtPop3Reply::Top7TOP POP3 command.


Member Function Documentation

QxtPop3Reply::~QxtPop3Reply ()   [virtual]

Destructs the QxtPop3Reply.

void QxtPop3Reply::cancel ()   [virtual]

Cancels the reply.

QString QxtPop3Reply::error () const

If an error occured, returns a string description of it.

See also status().

void QxtPop3Reply::finished ( int code )   [signal]

Emitted when the reply terminates. The return code indicates how the reply finished.

See also QxtPop3Reply::ReturnCode.

void QxtPop3Reply::progress ( int percent )   [signal]

Emitted to indicate the progress of the reply. percent is a number between 0 and 100, indicating the progress value as a percentage.

Status QxtPop3Reply::status () const

Return the current status of the reply.

Type QxtPop3Reply::type () const

Returns the type of the reply.


Copyright © 2007-2010 Qxt Foundation
Qxt 0.7.0