The QXmppTransferJob class represents a single file transfer job.
More...
#include <QXmppTransferManager.h>
|
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...
|
|
|
class | QXmppTransferManager |
|
class | QXmppTransferManagerPrivate |
|
class | QXmppTransferIncomingJob |
|
class | QXmppTransferOutgoingJob |
|
|
void | debug (const QString &message) |
|
void | info (const QString &message) |
|
void | warning (const QString &message) |
|
void | logReceived (const QString &message) |
|
void | logSent (const QString &message) |
|
The QXmppTransferJob class represents a single file transfer job.
- See also
- QXmppTransferManager
◆ 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.
|
◆ 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.
|
◆ 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.
|
◆ 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.
|
◆ abort
void QXmppTransferJob::abort |
( |
| ) |
|
|
slot |
Call this method if you wish to abort on ongoing transfer job.
◆ accept [1/2]
void QXmppTransferJob::accept |
( |
const QString & |
filePath | ) |
|
|
slot |
Call this method if you wish to accept an incoming transfer job.
◆ accept [2/2]
void QXmppTransferJob::accept |
( |
QIODevice * |
iodevice | ) |
|
|
slot |
Call this method if you wish to accept an incoming transfer job.
◆ error() [1/2]
Returns the last error that was encountered.
◆ error [2/2]
This signal is emitted when an error is encountered while processing the transfer job.
◆ fileInfo()
QXmppTransferFileInfo QXmppTransferJob::fileInfo |
( |
| ) |
const |
Returns meta-data about the file being transferred.
◆ finished
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().
◆ setLocalFileUrl()
void QXmppTransferJob::setLocalFileUrl |
( |
const QUrl & |
localFileUrl | ) |
|
Sets the local file URL.
- Note
- You do not need to call this method if you called accept() with a file path.
◆ sid()
QString QXmppTransferJob::sid |
( |
| ) |
const |
Returns the job's session identifier.
◆ speed()
qint64 QXmppTransferJob::speed |
( |
| ) |
const |
Returns the job's transfer speed in bytes per second.
If the transfer has not started yet or is already finished, returns 0.
◆ direction
Returns the job's transfer direction.
◆ jid
QString QXmppTransferJob::jid |
|
read |
Returns the remote party's JID.
◆ localFileUrl
QUrl QXmppTransferJob::localFileUrl |
|
readwrite |
Returns the local file URL.
◆ method
Returns the job's transfer method.
◆ state
The documentation for this class was generated from the following files: