Protocol trailer serialization and deserialization. More...
#include <trailer.h>
Public Member Functions | |
virtual | ~Trailer () |
virtual uint32_t | Deserialize (Buffer::Iterator end)=0 |
virtual uint32_t | GetSerializedSize (void) const =0 |
virtual void | Print (std::ostream &os) const =0 |
virtual void | Serialize (Buffer::Iterator start) const =0 |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
virtual TypeId | GetInstanceTypeId (void) const =0 |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
Protocol trailer serialization and deserialization.
Doxygen introspection did not find any typical Config paths.
Every Protocol trailer which needs to be inserted or removed from a Packet instance must derive from this base class and implement the pure virtual methods defined here.
No Attributes are defined for this type.
No TraceSources are defined for this type.
|
virtual |
Definition at line 11 of file trailer.cc.
References NS_LOG_FUNCTION.
|
pure virtual |
end | an iterator which points to the end of the buffer where the trailer should be read from. |
This method is used by Packet::RemoveTrailer to re-create a trailer from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this trailer in real networks. The input iterator points to the end of the area where the data shall be written. This method is thus expected to call Buffer::Iterator::Prev prio to actually reading any data.
Implements ns3::Chunk.
Implemented in anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >, anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >, ns3::EthernetTrailer, and ns3::WifiMacTrailer.
Referenced by ns3::Packet::PeekTrailer(), and ns3::Packet::RemoveTrailer().
|
pure virtual |
This method is used by Packet::AddTrailer to store a trailer into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full trailer data by Serialize.
Implemented in anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >, anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >, ns3::EthernetTrailer, and ns3::WifiMacTrailer.
Referenced by ns3::Packet::AddTrailer().
|
static |
Definition at line 17 of file trailer.cc.
References ns3::TypeId::SetParent().
Referenced by ns3::PacketMetadata::ItemIterator::Next().
|
pure virtual |
os | output stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 |
Implements ns3::Chunk.
Implemented in anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >, anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >, ns3::EthernetTrailer, and ns3::WifiMacTrailer.
Referenced by ns3::operator<<().
|
pure virtual |
start | an iterator which points to where the trailer should be written. |
This method is used by Packet::AddTrailer to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this trailer in real networks. The input iterator points to the end of the area where the data shall be written. This method is thus expected to call Buffer::Iterator::Prev prior to actually writing any data.
Implemented in anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >, anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >, ns3::EthernetTrailer, and ns3::WifiMacTrailer.
Referenced by ns3::Packet::AddTrailer().