Represents the LinkLayer Trailer. More...

#include "ble-linklayer-trailer.h"

Inheritance diagram for ns3::BleLinkLayerTrailer:

Collaboration diagram for ns3::BleLinkLayerTrailer:

Public Member Functions
	BleLinkLayerTrailer (void)
	Default Constructor More...

bool	CheckCrc24 (Ptr< const Packet > p)
	Check CRC of received packet with the trailer of the packet. More...

virtual uint32_t	Deserialize (Buffer::Iterator start)

uint32_t	GetCrc24 (void) const
	Get this trailer CRC value. More...

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 start) const

void	SetCrc24 (Ptr< const Packet > p)
	Calculate 24 bit CRC value for Packet. More...

void	SetCrcInit (uint32_t initVal)
	Set initial CRC value for CRC calculation. More...

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)
	Get the type ID. 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...

Private Member Functions
uint32_t	GenerateCrc24 (uint8_t *data, int length)
	Calculate the 24-bit CRC value. More...

Private Attributes
uint32_t	m_crcInitVal
	Initial value of CRC. More...

uint32_t	m_crcVal
	Value of generated CRC. More...

Additional Inherited Members
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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Represents the LinkLayer Trailer.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 38 of file ble-linklayer-trailer.h.

Constructor & Destructor Documentation

ns3::BleLinkLayerTrailer::BleLinkLayerTrailer ( void )

Default Constructor

Definition at line 30 of file ble-linklayer-trailer.cc.

Member Function Documentation

bool ns3::BleLinkLayerTrailer::CheckCrc24 ( Ptr< const Packet > p )

Check CRC of received packet with the trailer of the packet.

The packet in the param includes the trailer of the packet.

Definition at line 117 of file ble-linklayer-trailer.cc.

References ns3::Packet::CopyData(), GenerateCrc24(), ns3::Packet::GetSize(), and m_crcVal.

Referenced by ns3::BleLinkLayer::RxFromPhy().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::BleLinkLayerTrailer::Deserialize ( Buffer::Iterator end )

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 77 of file ble-linklayer-trailer.cc.

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

Here is the call graph for this function:

uint32_t ns3::BleLinkLayerTrailer::GenerateCrc24	(	uint8_t *	data,
		int	length
	)

private

Calculate the 24-bit CRC value.

Generator Polynomial = ^24 + ^10 + ^9 + ^6 + ^4 + ^3 + ^1 + ^0 Initial value = m_crcInitVal

Parameters

data	the checksum will be calculate over this data
length	the length of the data

Returns: the checksum

Definition at line 137 of file ble-linklayer-trailer.cc.

Referenced by CheckCrc24(), and SetCrc24().

Here is the caller graph for this function:

uint32_t ns3::BleLinkLayerTrailer::GetCrc24 ( void ) const

Get this trailer CRC value.

Returns: CTC value

Definition at line 94 of file ble-linklayer-trailer.cc.

References m_crcVal.

TypeId ns3::BleLinkLayerTrailer::GetInstanceTypeId ( void ) const

virtual

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 47 of file ble-linklayer-trailer.cc.

References GetTypeId().

Here is the call graph for this function:

uint32_t ns3::BleLinkLayerTrailer::GetSerializedSize ( void ) const

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 59 of file ble-linklayer-trailer.cc.

TypeId ns3::BleLinkLayerTrailer::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 36 of file ble-linklayer-trailer.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::BleLinkLayerTrailer::Print ( std::ostream & os ) const

virtual

Parameters

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

Definition at line 53 of file ble-linklayer-trailer.cc.

References m_crcVal.

void ns3::BleLinkLayerTrailer::Serialize ( Buffer::Iterator start ) const

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 65 of file ble-linklayer-trailer.cc.

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

Here is the call graph for this function: