Gnutella::Packets::Query Class Reference
#include <Query.h> [code]
Inherits Gnutella::Packets::Packet.
Inheritance diagram for Gnutella::Packets::Query:
Detailed Description
Encapsulates the Query Gnutella packet.The table below presents the data fields stored in a query's payload and how they can be accessed using the Query interface. For a detailed documentation of all basic Gnutella packets and the usage of all their fileds please refer to The Annotated Gnutella Protocol Specification v0.4.
| Byte Offset | Field Name | getFunction | setFunction |
| 0..1 | Minimum Speed | N/A | N/A |
| 2..N | Search Criteria String | N/A | N/A |
| N+1 | NUL (0x00) Terminator | N/A | N/A |
| N+2..L-1 | Optional Query Data | N/A | N/A |
- Todo:
- Implement the query data extension.
Definition at line 53 of file Query.h.
Public Member Functions | |
| Query (const QByteArray &rawHeader, const QByteArray &rawPayload) | |
| Query (const QString &searchCriteria=QString(), quint16 minimumSpeed=0) | |
| ~Query () | |
| Query * | copy () const |
| A virtual copy contructor. | |
| QString | name () const |
| quint16 | minimumSpeed () const |
| QString | searchCriteria () const |
| void | setMinimumSpeed (const quint16 &minimumSpeed) |
| void | setSearchCriteria (const QString &searchCriteria) |
Static Public Member Functions | |
| static Query & | castFrom (Packet &packet) |
| static const Query & | castFrom (const Packet &packet) |
Protected Member Functions | |
| bool | prepareReadPayload (const QByteArray &rawPayload) |
| Verifies the structure of the rawPayload. | |
| void | readPayload (QDataStream &stream) |
| Reads the payload fields from the stream. The structure of the data in the stream is already verified by verifyPayload(). | |
| int | prepareWritePayload () const |
| Gets ready to write the payload and returns the payload length. | |
| void | writePayload (QDataStream &stream) const |
| Writes the payload fields into the stream. | |
Private Types | |
| typedef Extensions::ExtensionBlock | QueryData |
Private Attributes | |
| Gnutella::Packets::Query::Data | p |
Classes | |
| struct | Data |
Member Typedef Documentation
|
|
|
Constructor & Destructor Documentation
|
||||||||||||
|
Creates a Query object from the raw bytes in rawHeader and rawPayload. |
|
||||||||||||
|
|
|
|
|
Member Function Documentation
|
|
|
|
|
|
|
|
A virtual copy contructor.
Implements Gnutella::Packets::Packet. |
|
|
|
|
|
Implements Gnutella::Packets::Packet. |
|
|
Verifies the structure of the rawPayload. Verifies if the rawPayload can be correctly parsed by readPayload(). The function just goes over the whole rawPayload and checks if the structure of the payload is correct. Some data may be gathered and stored to ease the work of readPayload(). For example, the size of the query hit data field can only be calculated with knowledge of the payloadLength, which is not available in the QDataStream object passed to readPayload(). The size of this field is read here and stored for use later in readPayload(). Implements Gnutella::Packets::Packet. |
|
|
Gets ready to write the payload and returns the payload length.
Implements Gnutella::Packets::Packet. |
|
|
Reads the payload fields from the stream. The structure of the data in the stream is already verified by verifyPayload().
Implements Gnutella::Packets::Packet. |
|
|
|
|
|
|
|
|
|
|
|
Writes the payload fields into the stream.
Implements Gnutella::Packets::Packet. |
Member Data Documentation
|
|
|
The documentation for this class was generated from the following files: