PacketStub.h

Go to the documentation of this file.
00001 /*
00002 
00003 Copyright (C) 2006-2007 by Peter Dimov.
00004 
00005 This file is part of Calitko (http://www.calitko.org).
00006 
00007 Calitko is free software; you can redistribute it and/or modify
00008 it under the terms of the GNU General Public License as published by
00009 the Free Software Foundation; either version 2 of the License, or
00010 (at your option) any later version.
00011 
00012 Calitko is distributed in the hope that it will be useful,
00013 but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 GNU General Public License for more details.
00016 
00017 You should have received a copy of the GNU General Public License
00018 along with Calitko; if not, write to the Free Software
00019 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 
00021 */
00022 
00023 #ifndef PROTOCOLS__GENERICS__TESTING__PACKET_STUB_H
00024 #define PROTOCOLS__GENERICS__TESTING__PACKET_STUB_H
00025 
00026 #include "Imports.h"
00027 #include "../PacketBase.h"
00028 
00029 namespace Protocols {
00030 namespace Generics {
00031 namespace Testing {
00032 
00034 
00053 class PacketStub : public PacketBase
00054 {
00055 public:
00056                         PacketStub (const QByteArray &header = QByteArray(),
00057                                     const QByteArray &payload = QByteArray(),
00058                                     bool checkReadBytes = false);
00059 
00060     QString             name() const;
00061     QString             protocol() const;
00062     auto_ptr <DataBase>
00063                         copy() const;
00064 
00065     bool                readHeader (const QByteArray &);
00066     bool                readPayload (const QByteArray &);
00067 
00068     QByteArray          writeHeader() const;
00069     QByteArray          writePayload() const;
00070 
00071     QByteArray          header() const;
00072     QByteArray          payload() const;
00073 
00074     // \todo Prefer to put in Packet? Not optimal to use because of the copying.
00075     QByteArray          rawPacket() const;
00076 
00077 protected:
00078     class Data : public PacketBase::Data
00079     {
00080         Q_SHARED_DATA_COPY (Data);
00081 
00082     public:
00083         QByteArray      header;
00084         QByteArray      payload;
00085         bool            checkReadBytes;
00086     };
00087 
00088     Q_DECLARE_SHARED_DATA (Data);
00089 };
00090 
00091 inline QByteArray PacketStub::header() const
00092 { Q_SD (const Data); return d->header; }
00093 
00094 inline QByteArray PacketStub::payload() const
00095 { Q_SD (const Data); return d->payload; }
00096 
00097 inline QByteArray PacketStub::rawPacket() const
00098 { return rawHeader() + rawPayload(); }
00099 
00100 } // Testing
00101 } // Generics
00102 } // Protocols
00103 
00104 #endif // PROTOCOLS__GENERICS__TESTING__PACKET_STUB_H