Header with a sequence, a timestamp, and a "size" attribute. More...
#include "seq-ts-size-header.h"
Public Member Functions | |
SeqTsSizeHeader () | |
constructor | |
uint32_t | Deserialize (Buffer::Iterator start) override |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint32_t | GetSerializedSize () const override |
uint64_t | GetSize () const |
Get the size information that the header is carrying. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetSize (uint64_t size) |
Set the size information that the header will carry. | |
Public Member Functions inherited from ns3::SeqTsHeader | |
SeqTsHeader () | |
uint32_t | Deserialize (Buffer::Iterator start) override |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
uint32_t | GetSeq () const |
uint32_t | GetSerializedSize () const override |
Time | GetTs () const |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetSeq (uint32_t seq) |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
uint32_t | Deserialize (Buffer::Iterator start) override=0 |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | GetSerializedSize () const =0 |
void | Print (std::ostream &os) const override=0 |
virtual void | Serialize (Buffer::Iterator start) const =0 |
virtual uint32_t | Deserialize (Buffer::Iterator start)=0 |
Deserialize the object from a buffer iterator. | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
virtual void | Print (std::ostream &os) const =0 |
Print the object contents. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::SeqTsHeader | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
uint64_t | m_size {0} |
The 'size' information that the header is carrying. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Header with a sequence, a timestamp, and a "size" attribute.
Introspection did not find any typical Config paths.
This header adds a size attribute to the sequence number and timestamp of class SeqTsHeader
. The size attribute can be used to track application data units for stream-based sockets such as TCP.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).
Definition at line 37 of file seq-ts-size-header.h.
ns3::SeqTsSizeHeader::SeqTsSizeHeader | ( | ) |
|
overridevirtual |
start | an iterator which points to where the header should read from. |
This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.
Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.
Reimplemented from ns3::SeqTsHeader.
Definition at line 90 of file seq-ts-size-header.cc.
References ns3::SeqTsHeader::Deserialize(), GetSerializedSize(), m_size, NS_LOG_FUNCTION, and ns3::Buffer::Iterator::ReadNtohU64().
|
overridevirtual |
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.
Reimplemented from ns3::SeqTsHeader.
Definition at line 49 of file seq-ts-size-header.cc.
References GetTypeId().
|
overridevirtual |
This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.
Reimplemented from ns3::SeqTsHeader.
Definition at line 75 of file seq-ts-size-header.cc.
References ns3::SeqTsHeader::GetSerializedSize().
Referenced by Deserialize(), ns3::PacketSink::PacketReceived(), BulkSendSeqTsSizeTestCase::ReceiveRx(), ns3::BulkSendApplication::SendData(), ns3::OnOffApplication::SendPacket(), and BulkSendSeqTsSizeTestCase::SendTx().
uint64_t ns3::SeqTsSizeHeader::GetSize | ( | ) | const |
Get the size information that the header is carrying.
Definition at line 61 of file seq-ts-size-header.cc.
References m_size.
Referenced by ns3::PacketSink::PacketReceived().
|
static |
Get the type ID.
Definition at line 39 of file seq-ts-size-header.cc.
References ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overridevirtual |
os | output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. 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 |
Reimplemented from ns3::SeqTsHeader.
Definition at line 67 of file seq-ts-size-header.cc.
References m_size, NS_LOG_FUNCTION, and ns3::SeqTsHeader::Print().
|
overridevirtual |
start | an iterator which points to where the header should be written. |
This method is used by Packet::AddHeader 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 header in a real network.
Reimplemented from ns3::SeqTsHeader.
Definition at line 81 of file seq-ts-size-header.cc.
References m_size, NS_LOG_FUNCTION, ns3::SeqTsHeader::Serialize(), and ns3::Buffer::Iterator::WriteHtonU64().
void ns3::SeqTsSizeHeader::SetSize | ( | uint64_t | size | ) |
Set the size information that the header will carry.
size | the size |
Definition at line 55 of file seq-ts-size-header.cc.
References m_size.
Referenced by ns3::BulkSendApplication::SendData(), and ns3::OnOffApplication::SendPacket().
|
private |
The 'size' information that the header is carrying.
Definition at line 71 of file seq-ts-size-header.h.
Referenced by Deserialize(), GetSize(), Print(), Serialize(), and SetSize().