A Discrete-Event Network Simulator
API
anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N > Class Template Reference

Template class for Test trailers. More...

+ Inheritance diagram for anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >:
+ Collaboration diagram for anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >:

Public Member Functions

 ATestTrailer ()
 
virtual uint32_t Deserialize (Buffer::Iterator iter)
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
virtual uint32_t GetSerializedSize (void) const
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator iter) const
 
- Public Member Functions inherited from anonymous_namespace{packet-test-suite.cc}::ATestTrailerBase
 ATestTrailerBase ()
 
- Public Member Functions inherited from ns3::Trailer
virtual ~Trailer ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from anonymous_namespace{packet-test-suite.cc}::ATestTrailerBase
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Trailer
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Additional Inherited Members

- Public Attributes inherited from anonymous_namespace{packet-test-suite.cc}::ATestTrailerBase
bool m_error
 Error in the Trailer. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

template<int N>
class anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >

Template class for Test trailers.

Note
Class internal to packet-test-suite.cc

Definition at line 330 of file packet-test-suite.cc.

Constructor & Destructor Documentation

template<int N>
anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::ATestTrailer ( )
inline

Definition at line 375 of file packet-test-suite.cc.

Member Function Documentation

template<int N>
virtual uint32_t anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::Deserialize ( Buffer::Iterator  end)
inlinevirtual
Parameters
endan 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 361 of file packet-test-suite.cc.

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

+ Here is the call graph for this function:

template<int N>
virtual TypeId anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::GetInstanceTypeId ( void  ) const
inlinevirtual

Get the most derived TypeId for this Object.

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

Returns
The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 348 of file packet-test-suite.cc.

template<int N>
virtual uint32_t anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::GetSerializedSize ( void  ) const
inlinevirtual
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 351 of file packet-test-suite.cc.

template<int N>
static TypeId anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::GetTypeId ( void  )
inlinestatic

Register this type.

Returns
The TypeId.

Definition at line 337 of file packet-test-suite.cc.

References ns3::TypeId::AddConstructor(), ns3::TypeId::HideFromDocumentation(), and ns3::TypeId::SetGroupName().

+ Here is the call graph for this function:

template<int N>
virtual void anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::Print ( std::ostream &  os) const
inlinevirtual
Parameters
osoutput 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::Trailer.

Definition at line 373 of file packet-test-suite.cc.

template<int N>
virtual void anonymous_namespace{packet-test-suite.cc}::ATestTrailer< N >::Serialize ( Buffer::Iterator  start) const
inlinevirtual
Parameters
startan 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 354 of file packet-test-suite.cc.

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

+ Here is the call graph for this function:


The documentation for this class was generated from the following file: