QNetworkOperation(3qt)QNetworkOperation(3qt)NAME
QNetworkOperation - This class is used to define
operations for network protocols and return the state,
arguments, etc
#include <qnetworkprotocol.h>
Inherits QObject.
Public Members
QNetworkOperation ( QNetworkProtocol::Operation operation,
const QString & arg0, const QString & arg1, const
QString & arg2 )
QNetworkOperation ( QNetworkProtocol::Operation operation,
const QByteArray & arg0, const QByteArray & arg1,
const QByteArray & arg2 )
~QNetworkOperation ()
void setState ( QNetworkProtocol::State state )
void setProtocolDetail ( const QString & detail )
void setErrorCode ( int ec )
void setArg ( int num, const QString & arg )
void setRawArg ( int num, const QByteArray & arg )
QNetworkProtocol::Operation operation () const
QNetworkProtocol::State state () const
QString arg ( int num ) const
QByteArray rawArg ( int num ) const
QString protocolDetail () const
int errorCode () const
void free ()
DESCRIPTION
This class is used to define operations for network
protocols and return the state, arguments, etc.
For each operation, which a network protocol should
process such an object is created to describe the
operation and the current state.
For a detailed description about the Qt Network
Architecture, and also how to implement and use network
protocols in Qt, look at the Qt Network Documentation.
See also QNetworkProtocol.
MEMBER FUNCTION DOCUMENTATIONQNetworkOperation::QNetworkOperation (
QNetworkProtocol::Operation operation, const QByteArray &
arg0, const QByteArray & arg1, const QByteArray & arg2 )
Constructs a network operation object. operation is the
type of the operation, arg0, arg1 and arg2 are the first
three raw data arguments of the operation. The state is
initialized to QNetworkProtocol::StWaiting.
Trolltech AS 13 June 2001 1
QNetworkOperation(3qt)QNetworkOperation(3qt)QNetworkOperation::QNetworkOperation (
QNetworkProtocol::Operation operation, const QString &
arg0, const QString & arg1, const QString & arg2 )
Constructs a network operation object. operation is the
type of the operation, arg0, arg1 and arg2 are the first
three arguments of the operation. The state is initialized
to QNetworkProtocol::StWaiting.
QNetworkOperation::~QNetworkOperation ()
Destructor.
QString QNetworkOperation::arg ( int num ) const
Returns the argument num of the operation. If this
argument was not set already, an empty string is returned.
int QNetworkOperation::errorCode () const
If an operation failed, you get the error code using this
methode.
void QNetworkOperation::free ()
If this method is called the QNetworkOperation deletes
itself after it has been 1 second unused, which means for
1 second no method of the QNetworkOperation has been
accessed.
Because QNetworkOperation pointers are passed around a lot
the QNetworkProtocol can't delete these at the correct
time. So, if a QNetworkProtocol doesn't need an operation
anymore and calls this method, so that it gets deleted
correctly.
You should never need to call the method yourself!.
QNetworkProtocol::Operation QNetworkOperation::operation() const
Returns the type of the operation.
QString QNetworkOperation::protocolDetail () const
If the operation failed, using this method you may get a
more detailed error message.
QByteArray QNetworkOperation::rawArg ( int num ) const
Returns the raw data argument num of the operation. If
this argument was not set already, an empty bytearray is
returned.
void QNetworkOperation::setArg ( int num, const QString & arg )
Sets the argument num of the network operation to arg.
void QNetworkOperation::setErrorCode ( int ec )
If the operation failed, the protocol should set an error
code to describe the error more detailed. Preferable one
of the error codes defined in QNetworkProtocol should be
used.
Trolltech AS 13 June 2001 2
QNetworkOperation(3qt)QNetworkOperation(3qt)void QNetworkOperation::setProtocolDetail ( const QString &
detail )
If the operation failed a detailed error message can be
set.
void QNetworkOperation::setRawArg ( int num, const QByteArray &
arg )
Sets the raw data argument num of the network operation to
arg.
void QNetworkOperation::setState ( QNetworkProtocol::State state
)
Sets the state of the operation object. This should be
done by the network protocol during processing it, and at
the end it should be set to QNetworkProtocol::StDone or
QNetworkProtocol::StFailed depending on success or
failure.
QNetworkProtocol::State QNetworkOperation::state() const
Returns the state of the operation. Using that you can
find out if an operation is still waiting to get
processed, if it is in process or if has been done
successfully or if it failed.
SEE ALSO
http://doc.trolltech.com/qnetworkoperation.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2001 Trolltech AS,
http://www.trolltech.com. See the license file included
in the distribution for a complete license statement.
AUTHOR
Generated automatically from the source code.
BUGS
If you find a bug in Qt, please report it as described in
http://doc.trolltech.com/bughowto.html. Good bug reports
make our job much simpler. Thank you.
In case of content or formattting problems with this
manual page, please report them to qt-bugs@trolltech.com.
Please include the name of the manual page
(qnetworkoperation.3qt) and the Qt version (2.3.1).
Trolltech AS 13 June 2001 3
