diff -r cb4ae01ba180 -r 2c31ae7c94db src/common/chunk.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/common/chunk.h Tue Aug 29 17:42:13 2006 +0200 @@ -0,0 +1,89 @@ +/* -*- Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */ +/* + * Copyright (c) 2005 INRIA + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation; + * + * This program 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 this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * Author: Mathieu Lacage + */ + +#ifndef CHUNK_H +#define CHUNK_H + +#include +#include +#include "buffer.h" + +namespace yans { + +/** + * \brief Protocol header serialization and deserialization. + * + * Every Protocol header which needs to be inserted and removed + * from a Packet instance must derive from this abstract base class + * and implement the private pure virtual methods defined here. + */ +class Chunk { +public: + Chunk (); + /** + * Derived classes must provided an explicit virtual destructor + */ + virtual ~Chunk () = 0; + + void print (std::ostream &os) const; + + void add (Buffer *buffer) const; + void peek (Buffer const *buffer); + void remove (Buffer *buffer); +private: + bool m_must_peek_before_remove; + /** + * \param os the std output stream in which this + * protocol header must print itself. + */ + virtual void print (std::ostream *os) const = 0; + + /** + * \param buffer the buffer in which the protocol header + * must serialize itself. + * + * This method must: + * - reserve room for its serialized representation in the input buffer + * - serialize itself in this reserved room + */ + virtual void add_to (Buffer *buffer) const = 0; + /** + * \param buffer the buffer from which the protocol header must + * deserialize itself. + * + */ + virtual void peek_from (Buffer const *buffer) = 0; + /** + * \param buffer the buffer from which the protocol header + * must remove itself. + * + * This method must remove its serialized representation + * from the input buffer. This method does not need to deserialize + * the data itself. + */ + virtual void remove_from (Buffer *buffer) = 0; +}; + +std::ostream& operator<< (std::ostream& os, Chunk const& chunk); + +}; // namespace yans + +#endif /* CHUNK_H */