PacketBase.h

Go to the documentation of this file.

/*

Copyright (C) 2006-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 PROTOCOLS__GENERICS__PACKET_BASE_H
#define PROTOCOLS__GENERICS__PACKET_BASE_H

#include "Imports.h"
//#include "DataBase.h"
#include "Data.h" // \todo change to AbstractValue.h or move to Import.h

namespace Protocols {
namespace Generics {

class PacketVisitor;
class PacketFactory;
FORWARD_DECLARE (Testing, class PacketTest)



class PacketBase : public DataBase
{
public:
    virtual             ~PacketBase();

    // DataBase pure virtual functions:
    virtual auto_ptr <DataBase>
                        copy() const = 0;
    QByteArray          toRawBytes() const;

    // Own (new) functions:
    virtual QString     protocol() const = 0;
    virtual QString     name() const = 0;
    //virtual void      accept (PacketVisitor &); //! Infrastructure for the visitor pattern.

    bool                parse (const QByteArray &rawHeader,
                               const QByteArray &rawPayload);

    QByteArray          rawHeader() const;
    QByteArray          rawPayload() const;
    QByteArray          rawPacket() const;

    quint32             headerLength() const;
    quint32             payloadLength() const;
    quint32             packetLength() const;

protected:
    class Data;         // Needed for ctor declaration.
                        PacketBase (Data *d);

    virtual void        invalidateHeader();
    virtual void        invalidatePayload();

    virtual bool        readHeader (const QByteArray &rawHeader) = 0;
    virtual bool        readPayload (const QByteArray &rawPayload) = 0;

    virtual QByteArray  writeHeader() const = 0;
    virtual QByteArray  writePayload() const = 0;


    class Data : public SharedData
    {
    public:
        Data() : rawHeader(), rawPayload(), rewriteHeader(), rewritePayload() {}

        mutable QByteArray  rawHeader;
        mutable QByteArray  rawPayload;
        mutable bool        rewriteHeader;
        mutable bool        rewritePayload;
    };

    SharedDataPointer       d_ptr;

private:
    Q_DECLARE_SHARED_DATA (Data);

    friend class PacketFactory;
    friend class Testing::PacketTest; // \todo swith to CalitkoMocks??

    bool                doParse (const QByteArray &rawHeader,
                                 const QByteArray &rawPayload);
};

inline QByteArray PacketBase::rawPacket() const
{ return rawHeader() + rawPayload(); }


inline quint32 PacketBase::headerLength() const
{ return rawHeader().length(); }


inline quint32 PacketBase::payloadLength() const
{ return rawPayload().length(); }


inline quint32 PacketBase::packetLength() const
{ return headerLength() + payloadLength(); }

inline QByteArray PacketBase::toRawBytes() const
{ return rawPacket(); }

} // namespace Generics
} // namespace Protocols

#endif // PROTOCOLS__GENERICS__PACKET_BASE_H

Copyright © 2006 Peter Dimov.
Powered by Doxygen.