-

QXmppTransferJob Class Reference

-

The QXmppTransferJob class represents a single file transfer job. -More...

- -

#include <QXmppTransferManager.h>

- -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Types
enum	Direction { IncomingDirection, -OutgoingDirection - }
	This enum is used to describe the direction of a transfer job. - More...
enum	Error { - NoError = 0, -AbortError, -FileAccessError, -FileCorruptError, - - ProtocolError - - }
	This enum is used to describe the type of error encountered by a transfer job. - More...
enum	Method { NoMethod = 0, -InBandMethod = 1, -SocksMethod = 2, -AnyMethod = 3 - }
	This enum is used to describe a transfer method. - More...
enum	State { OfferState = 0, -StartState = 1, -TransferState = 2, -FinishedState = 3 - }
	This enum is used to describe the state of a transfer job. - More...
Signals
void	error (QXmppTransferJob::Error error)
void	finished ()
-void	progress (qint64 done, qint64 total)
	This signal is emitted to indicate the progress of this transfer job.
-void	stateChanged (QXmppTransferJob::State state)
	This signal is emitted when the transfer job changes state.
Public Member Functions
void	abort ()
void	accept (QIODevice *output)
QVariant	data (int role) const
void	setData (int role, const QVariant &value)
QXmppTransferJob::Direction	direction () const
QXmppTransferJob::Error	error () const
QString	jid () const
QXmppTransferJob::Method	method () const
QString	sid () const
QXmppTransferJob::State	state () const
QXmppTransferFileInfo	fileInfo () const
-QDateTime	fileDate () const
-QByteArray	fileHash () const
-QString	fileName () const
-qint64	fileSize () const
Friends
-class	QXmppTransferManager

-

Detailed Description

-

The QXmppTransferJob class represents a single file transfer job.

-

See also:: QXmppTransferManager

-

Member Enumeration Documentation

- -

-

- - - - -

enum QXmppTransferJob::Direction

-

- -

This enum is used to describe the direction of a transfer job.

-

Enumerator:

- - -

IncomingDirection	- The file is being received. -
OutgoingDirection	- The file is being sent. -

-

- -

-

- -

-

- - - - -

enum QXmppTransferJob::Error

-

- -

This enum is used to describe the type of error encountered by a transfer job.

-

Enumerator:

- - - - - -

NoError	- No error occurred. -
AbortError	- The file transfer was aborted. -
FileAccessError	- An error was encountered trying to access a local file. -
FileCorruptError	- The file is corrupt: the file size or hash do not match. -
ProtocolError	- An error was encountered in the file transfer protocol. -

-

- -

-

- -

-

- - - - -

enum QXmppTransferJob::Method

-

- -

This enum is used to describe a transfer method.

-

Enumerator:

- - - - -

NoMethod	- No transfer method. -
InBandMethod	- XEP-0047: In-Band Bytestreams. -
SocksMethod	- XEP-0065: SOCKS5 Bytestreams. -
AnyMethod	- Any supported transfer method. -

-

- -

-

- -

-

- - - - -

enum QXmppTransferJob::State

-

- -

This enum is used to describe the state of a transfer job.

-

Enumerator:

- - - - -

OfferState	- The transfer is being offered to the remote party. -
StartState	- The transfer is being connected. -
TransferState	- The transfer is ongoing. -
FinishedState	- The transfer is finished. -

-

- -

-

Member Function Documentation

- -

-

- - - - - - - - -

void QXmppTransferJob::abort ( )

-

Call this method if you wish to abort on ongoing transfer job.

- -

-

- -

-

- - - - - - - - - -

void QXmppTransferJob::accept ( QIODevice * iodevice )

-

Call this method if you wish to accept an incoming transfer job.

- -

-

- -

-

- - - - - - - - - -

QVariant QXmppTransferJob::data ( int role ) const

-

Returns the job's data for a given role.

-

You can associate arbitrary data with the role using setData().

- -

-

- -

-

- - - - - - - - -

QXmppTransferJob::Direction QXmppTransferJob::direction ( ) const

-

Returns the job's transfer direction.

- -

-

- -

-

- - - - - - - - - -

void QXmppTransferJob::error ( QXmppTransferJob::Error error ) [signal]

-

This signal is emitted when an error is encountered while processing the transfer job.

- -

-

- -

-

- - - - - - - - -

QXmppTransferJob::Error QXmppTransferJob::error ( ) const

-

Returns the last error that was encountered.

- -

-

- -

-

- - - - - - - - -

QXmppTransferFileInfo QXmppTransferJob::fileInfo ( ) const

-

Returns meta-data about the file being transfered.

- -

-

- -

-

- - - - - - - - -

void QXmppTransferJob::finished ( ) [signal]

-

This signal is emitted when the transfer job is finished.

-

You can determine if the job completed successfully by testing whether error() returns QXmppTransferJob::NoError.

-

Note: Do not delete the job in the slot connected to this signal, instead use deleteLater().

- -

-

- -

-

- - - - - - - - -

QString QXmppTransferJob::jid ( ) const

-

Returns the remote party's JID.

- -

-

- -

-

- - - - - - - - -

QXmppTransferJob::Method QXmppTransferJob::method ( ) const

-

Returns the job's transfer method.

- -

-

- -

-

- - - - - - - - - - - - - - - - - - -

void QXmppTransferJob::setData	(	int	role,
		const QVariant &	value
	)

-

Sets the data for a given role to the given value.

-

You can set any data you want for use in your application, this data will not be used internally by QXmppTransferManager.

- -

-

- -

-

- - - - - - - - -

QString QXmppTransferJob::sid ( ) const

-

Returns the job's session identifier.

- -

-

- -

-

- - - - - - - - -

QXmppTransferJob::State QXmppTransferJob::state ( ) const

-

Returns the job's state.

- -

-

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

QXmppTransferManager.h
QXmppTransferManager.cpp

-

QXmppTransferJob Class Reference

Public Types

Signals

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Member Function Documentation