QueryHits.h

Go to the documentation of this file.

/*

Copyright (C) 2005-2007 by Peter Dimov.

This file is part of Calitko (http://www.calitko.org).

Calitko is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

Calitko is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Calitko; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

*/

#ifndef QUERYHITS_H
#define QUERYHITS_H

#include "Packet.h"
#include "VendorCode.h"
#include "Extensions/ExtensionBlock.h"
#include "Extensions/GgepBlock.h"

// Open containing namespaces:
namespace Gnutella {
namespace Packets {


class QueryHits : public Packet
{
public:
    typedef Extensions::ExtensionBlock ResultData;

    struct Result
    {
        Result() : fileIndex (0), fileSize (0), fullFileName(), resultData(),
                   fileNameSize (0) {}

        quint32         fileIndex;      
        quint32         fileSize;       
        QString         fullFileName;   
        ResultData      resultData;     

        quint16         fileNameSize;   

        QString         fileExtension() const;
        QString         fileName() const;
        quint32         sizeOfFile() const;
    };

    static QueryHits &          castFrom (Packet & packet)              { return dynamic_cast <QueryHits &> (packet); }
    static const QueryHits &    castFrom (const Packet & packet)        { return dynamic_cast <const QueryHits &> (packet); }

                        QueryHits (const QByteArray &rawHeader, const QByteArray &rawPayload);
                        QueryHits ();
                        ~QueryHits();

    QueryHits*          copy() const                    { return new QueryHits (*this); }

    QString             name() const                    { return QString ("QueryHits"); }

//  uchar               numberOfHits() const            { return p.numberOfHits; }
    uchar               numberOfHits() const            { return p.resultSet.size(); }
    quint16             port () const                   { return p.port; }
    QHostAddress        ipAddress() const               { return p.ipAddress; }
    quint32             speed() const                   { return p.speed; }
    const Result &      result (int &index) const;
    //  QueryHitsData   queryHitsData;  //!< The optional query hits data payload field.
    const QUuid &       serventId() const               { return p.serventId; }     


    void    setPort (quint16 port);
    void    setIpAddress (const QHostAddress &ipAddress);
    void    setSpeed (quint32 speed);
    void    setServentId (const QUuid &serventId);
    //void  setQueryHitsData (QByteArray &data);
    void    appendResult (Result &result);

protected:
    bool    prepareReadPayload (const QByteArray &rawPayload);
    bool    prepareReadQueryHitsData (const QByteArray &rawQueryHitsData);
    void    readPayload (QDataStream &stream);
    void    readQueryHitsData (QDataStream &stream);
    int     prepareWritePayload() const;
    int     prepareWriteQueryHitsData() const;
    void    writePayload (QDataStream &stream) const;
    void    writeQueryHitsData (QDataStream &stream) const;

private:

    struct QueryHitsData
    {
                                QueryHitsData();

        VendorCode              vendorCode;
        mutable uchar           openAreaSize;
        uchar                   openAreaFlags1;
        mutable uchar           openAreaFlags2;
        mutable quint16         xmlLength;
        uchar                   privateVendorFlag;
        Extensions::GgepBlock   ggepBlock;
        QByteArray              xmlData;
    };

    typedef QList<Result> ResultSet;
    struct Data
    {
        uchar           numberOfHits;   
        quint16         port;           
        QHostAddress    ipAddress;      
        quint32         speed;          
        ResultSet       resultSet;      
        QueryHitsData   queryHitsData;  
        QUuid           serventId;      
    } p;
};

// Close containing namespaces:
} // namespace Packets
} // namespace Gnutella

#endif // QUERYHITS_H

Copyright © 2006 Peter Dimov.
Powered by Doxygen.