98 lines
3.2 KiB
C++
98 lines
3.2 KiB
C++
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
|
|
/*
|
|
* 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 <mathieu.lacage@sophia.inria.fr>
|
|
*/
|
|
|
|
#ifndef HEADER_H
|
|
#define HEADER_H
|
|
|
|
#include "chunk.h"
|
|
|
|
namespace ns3 {
|
|
|
|
/**
|
|
* \brief Protocol header serialization and deserialization.
|
|
*
|
|
* Every Protocol header which needs to be inserted or removed
|
|
* from a Packet instance must derive from this abstract base class
|
|
* and implement the private pure virtual methods listed below:
|
|
* - ns3::Header::SerializeTo
|
|
* - ns3::Header::DeserializeFrom
|
|
* - ns3::Header::GetSerializedSize
|
|
* - ns3::Header::PrintTo
|
|
*/
|
|
class Header : public Chunk {
|
|
public:
|
|
virtual ~Header ();
|
|
private:
|
|
/**
|
|
* \returns a user-readable name to identify this type of header.
|
|
*
|
|
* The string returned is expected to be a single word with
|
|
* all capital letters
|
|
*/
|
|
virtual std::string DoGetName (void) const = 0;
|
|
/**
|
|
* \param os the std output stream in which this
|
|
* protocol header must print itself.
|
|
*
|
|
* Although the header is free to format its output as it
|
|
* wishes, it is recommended to follow a few rules to integrate
|
|
* with the packet pretty printer:
|
|
* - start with flags, small field values located between a
|
|
* pair of parens. Values should be separated by whitespace.
|
|
* - follow the parens with the important fields, separated by
|
|
* whitespace.
|
|
* i.e.:
|
|
* (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5
|
|
*/
|
|
virtual void PrintTo (std::ostream &os) const = 0;
|
|
|
|
/**
|
|
* \returns the size of the serialized Header.
|
|
*
|
|
* This method is used by Packet::AddHeader to reserve
|
|
* enough room in the packet byte buffer prior to calling
|
|
* Header::Serialize.
|
|
*/
|
|
virtual uint32_t GetSerializedSize (void) const = 0;
|
|
|
|
/**
|
|
* \param start the buffer iterator in which the protocol header
|
|
* must serialize itself. This iterator identifies
|
|
* the start of the buffer.
|
|
*/
|
|
virtual void SerializeTo (Buffer::Iterator start) const = 0;
|
|
/**
|
|
* \param start the buffer iterator from which the protocol header must
|
|
* deserialize itself. This iterator identifies
|
|
* the start of the buffer.
|
|
* \returns the number of bytes read from the buffer
|
|
*
|
|
* The value returned is used to trim the packet byte buffer of the
|
|
* corresponding amount when this method is invoked from
|
|
* Packet::RemoveHeader
|
|
*/
|
|
virtual uint32_t DeserializeFrom (Buffer::Iterator start) = 0;
|
|
};
|
|
|
|
}; // namespace ns3
|
|
|
|
#endif /* HEADER_H */
|