From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qnetworkoperation.html | 169 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 doc/html/qnetworkoperation.html (limited to 'doc/html/qnetworkoperation.html') diff --git a/doc/html/qnetworkoperation.html b/doc/html/qnetworkoperation.html new file mode 100644 index 000000000..d3510b220 --- /dev/null +++ b/doc/html/qnetworkoperation.html @@ -0,0 +1,169 @@ + + + + + +TQNetworkOperation Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQNetworkOperation Class Reference
[network module]

+ +

The TQNetworkOperation class provides common operations for network protocols. +More... +

#include <qnetworkprotocol.h> +

Inherits TQObject. +

List of all member functions. +

Public Members

+ +

Detailed Description

+ + +

The TQNetworkOperation class provides common operations for network protocols. + +

+ +

An object is created to describe the operation and the current +state for each operation that a network protocol should process. +

For a detailed description of the TQt Network Architecture and how +to implement and use network protocols in TQt, see the TQt Network Documentation. +

See also TQNetworkProtocol and Input/Output and Networking. + +

Member Function Documentation

+

TQNetworkOperation::TQNetworkOperation ( TQNetworkProtocol::Operation operation, const TQString & arg0, const TQString & arg1, const TQString & arg2 ) +

+Constructs a network operation object. operation is the type of +the operation, and arg0, arg1 and arg2 are the first +three arguments of the operation. The state is initialized to +TQNetworkProtocol::StWaiting. +

See also TQNetworkProtocol::Operation and TQNetworkProtocol::State. + +

TQNetworkOperation::TQNetworkOperation ( TQNetworkProtocol::Operation operation, const TQByteArray & arg0, const TQByteArray & arg1, const TQByteArray & arg2 ) +

+Constructs a network operation object. operation is the type of +the operation, and arg0, arg1 and arg2 are the first +three raw data arguments of the operation. The state is +initialized to TQNetworkProtocol::StWaiting. +

See also TQNetworkProtocol::Operation and TQNetworkProtocol::State. + +

TQNetworkOperation::~TQNetworkOperation () +

+Destructor. + +

TQString TQNetworkOperation::arg ( int num ) const +

+Returns the operation's num-th argument. If this argument was +not already set, an empty string is returned. + +

Example: network/networkprotocol/nntp.cpp. +

int TQNetworkOperation::errorCode () const +

+Returns the error code for the last error that occurred. + +

void TQNetworkOperation::free () +

+Sets this object to delete itself when it hasn't been used for one +second. +

Because TQNetworkOperation pointers are passed around a lot the +TQNetworkProtocol generally does not have enough knowledge to +delete these at the correct time. If a TQNetworkProtocol doesn't +need an operation any more it will call this function instead. +

Note: you should never need to call the method yourself. + +

TQNetworkProtocol::Operation TQNetworkOperation::operation () const +

+Returns the type of the operation. + +

TQString TQNetworkOperation::protocolDetail () const +

+Returns a detailed error message for the last error. This must +have been set using setProtocolDetail(). + +

TQByteArray TQNetworkOperation::rawArg ( int num ) const +

+Returns the operation's num-th raw data argument. If this +argument was not already set, an empty bytearray is returned. + +

void TQNetworkOperation::setArg ( int num, const TQString & arg ) +

+Sets the network operation's num-th argument to arg. + +

void TQNetworkOperation::setErrorCode ( int ec ) +

+Sets the error code to ec. +

If the operation failed, the protocol should set an error code to +describe the error in more detail. If possible, one of the error +codes defined in TQNetworkProtocol should be used. +

See also setProtocolDetail() and TQNetworkProtocol::Error. + +

void TQNetworkOperation::setProtocolDetail ( const TQString & detail ) +

+If the operation failed, the error message can be specified as detail. + +

void TQNetworkOperation::setRawArg ( int num, const TQByteArray & arg ) +

+Sets the network operation's num-th raw data argument to arg. + +

void TQNetworkOperation::setState ( TQNetworkProtocol::State state ) +

+Sets the state of the operation object. This should be done by +the network protocol during processing; at the end it should be +set to TQNetworkProtocol::StDone or TQNetworkProtocol::StFailed, +depending on success or failure. +

See also TQNetworkProtocol::State. + +

TQNetworkProtocol::State TQNetworkOperation::state () const +

+Returns the state of the operation. You can determine whether an +operation is still waiting to be processed, is being processed, +has been processed successfully, or failed. + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1