anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N > Class Template Reference

Inheritance diagram for anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >:
Inheritance graph
[legend]
Collaboration diagram for anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 HistoryTrailer ()
bool IsOk (void) const
virtual TypeId GetInstanceTypeId (void) const
virtual void Print (std::ostream &os) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (Buffer::Iterator start) const
virtual uint32_t Deserialize (Buffer::Iterator start)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Trailer.

Private Attributes

bool m_ok

Detailed Description

template<int N>
class anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >

Definition at line 177 of file packet-metadata-test.cc.


Constructor & Destructor Documentation

template<int N>
anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::HistoryTrailer (  )  [inline]

Definition at line 194 of file packet-metadata-test.cc.


Member Function Documentation

template<int N>
uint32_t anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::Deserialize ( Buffer::Iterator  end  )  [inline, virtual]
Parameters:
end an iterator which points to the end of the buffer where the trailer should be read from.
Returns:
the number of bytes read.

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::Trailer.

Definition at line 237 of file packet-metadata-test.cc.

References ns3::Buffer::Iterator::Prev(), ns3::Buffer::Iterator::ReadU8(), and anonymous_namespace{packet-metadata-test.cc}::HistoryTrailerBase::ReportError().

template<int N>
TypeId anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::GetInstanceTypeId ( void   )  const [inline, virtual]
Returns:
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 212 of file packet-metadata-test.cc.

References anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::GetTypeId().

template<int N>
uint32_t anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::GetSerializedSize ( void   )  const [inline, virtual]
Returns:
the expected size of the trailer.

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.

Implements ns3::Trailer.

Definition at line 224 of file packet-metadata-test.cc.

template<int N>
TypeId anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::GetTypeId ( void   )  [inline, static]

This method returns the TypeId associated to ns3::Trailer.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from anonymous_namespace{packet-metadata-test.cc}::HistoryTrailerBase.

Definition at line 199 of file packet-metadata-test.cc.

References ns3::TypeId::AddConstructor().

Referenced by anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::GetInstanceTypeId().

template<int N>
bool anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::IsOk ( void   )  const
template<int N>
void anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::Print ( std::ostream &  os  )  const [inline, virtual]

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::Trailer.

Definition at line 218 of file packet-metadata-test.cc.

References NS_ASSERT.

template<int N>
void anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::Serialize ( Buffer::Iterator  start  )  const [inline, virtual]
Parameters:
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.

Implements ns3::Trailer.

Definition at line 230 of file packet-metadata-test.cc.

References ns3::Buffer::Iterator::Prev(), and ns3::Buffer::Iterator::WriteU8().


Member Data Documentation

template<int N>
bool anonymous_namespace{packet-metadata-test.cc}::HistoryTrailer< N >::m_ok [private]

The documentation for this class was generated from the following file:
Generated on Thu Dec 3 14:09:48 2009 for NS-3 by  doxygen 1.6.3