This class represents a message. More...

#include <src/core/common/message.hpp>

Inheritance diagram for ot::Message:

Public Types
enum	{ kTypeIp6 = 0, kType6lowpan = 1, kTypeMacDataPoll = 2, kTypeSupervision = 3 }

enum	{ kSubTypeNone = 0, kSubTypeMleAnnounce = 1, kSubTypeMleDiscoverRequest = 2, kSubTypeMleDiscoverResponse = 3, kSubTypeJoinerEntrust = 4, kSubTypeMplRetransmission = 5, kSubTypeMleGeneral = 6, kSubTypeJoinerFinalizeResponse = 7, kSubTypeMleChildUpdateRequest = 8 }

enum	{ kPriorityHigh = 0, kPriorityMedium = 1, kPriorityLow = 2, kPriorityVeryLow = 3, kNumPriorities = 4 }

Public Member Functions
void	Free (void)
	This method frees this message buffer.

Message *	GetNext (void) const
	This method returns a pointer to the next message in the same interface list. More...

uint16_t	GetLength (void) const
	This method returns the number of bytes in the message. More...

otError	SetLength (uint16_t aLength)
	This method sets the number of bytes in the message. More...

uint8_t	GetBufferCount (void) const
	This method returns the number of buffers in the message.

uint16_t	GetOffset (void) const
	This method returns the byte offset within the message. More...

otError	MoveOffset (int aDelta)
	This method moves the byte offset within the message. More...

otError	SetOffset (uint16_t aOffset)
	This method sets the byte offset within the message. More...

uint8_t	GetType (void) const
	This method returns the type of the message. More...

void	SetType (uint8_t aType)
	This method sets the message type. More...

uint8_t	GetSubType (void) const
	This method returns the sub type of the message. More...

void	SetSubType (uint8_t aSubType)
	This method sets the message sub type. More...

bool	IsSubTypeMle (void) const
	This method returns whether or not the message is of MLE subtype. More...

uint8_t	GetPriority (void) const
	This method returns the message priority level. More...

otError	SetPriority (uint8_t aPriority)
	This method sets the messages priority. More...

otError	Prepend (const void *aBuf, uint16_t aLength)
	This method prepends bytes to the front of the message. More...

otError	RemoveHeader (uint16_t aLength)
	This method removes header bytes from the message. More...

otError	Append (const void *aBuf, uint16_t aLength)
	This method appends bytes to the end of the message. More...

uint16_t	Read (uint16_t aOffset, uint16_t aLength, void *aBuf) const
	This method reads bytes from the message. More...

int	Write (uint16_t aOffset, uint16_t aLength, const void *aBuf)
	This method writes bytes to the message. More...

int	CopyTo (uint16_t aSourceOffset, uint16_t aDestinationOffset, uint16_t aLength, Message &aMessage) const
	This method copies bytes from one message to another. More...

Message *	Clone (uint16_t aLength) const
	This method creates a copy of the current Message. More...

Message *	Clone (void) const
	This method creates a copy of the current Message. More...

uint16_t	GetDatagramTag (void) const
	This method returns the datagram tag used for 6LoWPAN fragmentation. More...

void	SetDatagramTag (uint16_t aTag)
	This method sets the datagram tag used for 6LoWPAN fragmentation. More...

bool	GetChildMask (uint8_t aChildIndex) const
	This method returns whether or not the message forwarding is scheduled for the child. More...

void	ClearChildMask (uint8_t aChildIndex)
	This method unschedules forwarding of the message to the child. More...

void	SetChildMask (uint8_t aChildIndex)
	This method schedules forwarding of the message to the child. More...

bool	IsChildPending (void) const
	This method returns whether or not the message forwarding is scheduled for at least one child. More...

uint16_t	GetPanId (void) const
	This method returns the IEEE 802.15.4 Destination PAN ID. More...

void	SetPanId (uint16_t aPanId)
	This method sets the IEEE 802.15.4 Destination PAN ID. More...

uint8_t	GetChannel (void) const
	This method returns the IEEE 802.15.4 Channel to use for transmission. More...

void	SetChannel (uint8_t aChannel)
	This method sets the IEEE 802.15.4 Channel to use for transmission. More...

uint8_t	GetTimeout (void) const
	This method returns the timeout used for 6LoWPAN reassembly. More...

void	SetTimeout (uint8_t aTimeout)
	This method sets the timeout used for 6LoWPAN reassembly. More...

int8_t	GetInterfaceId (void) const
	This method returns the interface ID. More...

void	SetInterfaceId (int8_t aInterfaceId)
	This method sets the interface ID. More...

bool	GetDirectTransmission (void) const
	This method returns whether or not message forwarding is scheduled for direct transmission. More...

void	ClearDirectTransmission (void)
	This method unschedules forwarding using direct transmission.

void	SetDirectTransmission (void)
	This method schedules forwarding using direct transmission.

bool	IsLinkSecurityEnabled (void) const
	This method indicates whether or not link security is enabled for the message. More...

void	SetLinkSecurityEnabled (bool aEnabled)
	This method sets whether or not link security is enabled for the message. More...

void	AddRss (int8_t aRss)
	This method updates the average RSS (Received Signal Strength) associated with the message by adding the given RSS value to the average. More...

int8_t	GetAverageRss (void) const
	This method returns the average RSS (Received Signal Strength) associated with the message. More...

const RssAverager &	GetRssAverager (void) const
	This method returns a const reference to RssAverager of the message. More...

uint16_t	UpdateChecksum (uint16_t aChecksum, uint16_t aOffset, uint16_t aLength) const
	This method is used to update a checksum value. More...

MessageQueue *	GetMessageQueue (void) const
	This method returns a pointer to the message queue (if any) where this message is queued. More...

Public Member Functions inherited from ot::Buffer
class Buffer *	GetNextBuffer (void) const
	This method returns a pointer to the next message buffer. More...

void	SetNextBuffer (class Buffer *buf)
	This method sets the pointer to the next message buffer.

Static Public Member Functions
static uint16_t	UpdateChecksum (uint16_t aChecksum, uint16_t aValue)
	This static method updates a checksum. More...

static uint16_t	UpdateChecksum (uint16_t aChecksum, const void *aBuf, uint16_t aLength)
	This static method updates a checksum. More...

Friends
class	MessagePool

class	MessageQueue

class	PriorityQueue

Additional Inherited Members
Public Attributes inherited from otMessage
struct otMessage *	mNext
	A pointer to the next Message buffer.

Detailed Description

This class represents a message.

Member Enumeration Documentation

§ anonymous enum

anonymous enum

Enumerator
kTypeIp6	A full uncompressed IPv6 packet.
kType6lowpan	A 6lowpan frame.
kTypeMacDataPoll	A MAC data poll message.
kTypeSupervision	A child supervision frame.

§ anonymous enum

anonymous enum

Enumerator
kSubTypeNone	None.
kSubTypeMleAnnounce	MLE Announce.
kSubTypeMleDiscoverRequest	MLE Discover Request.
kSubTypeMleDiscoverResponse	MLE Discover Response.
kSubTypeJoinerEntrust	Joiner Entrust.
kSubTypeMplRetransmission	MPL next retransmission message.
kSubTypeMleGeneral	General MLE.
kSubTypeJoinerFinalizeResponse	Joiner Finalize Response.
kSubTypeMleChildUpdateRequest	MLE Child Update Request.

§ anonymous enum

anonymous enum

Enumerator
kPriorityHigh	High priority level.
kPriorityMedium	Medium priority level.
kPriorityLow	Low priority level.
kPriorityVeryLow	Very low priority level.
kNumPriorities	Number of priority levels.

Member Function Documentation

§ AddRss()

void ot::Message::AddRss ( int8_t aRss )

inline

This method updates the average RSS (Received Signal Strength) associated with the message by adding the given RSS value to the average.

Note that a message can be composed of multiple 802.15.4 data frame fragments each received with a different signal strength.

Parameters

[in] aRss A new RSS value (in dBm) to be added to average.

§ Append()

otError ot::Message::Append	(	const void *	aBuf,
		uint16_t	aLength
	)

This method appends bytes to the end of the message.

On success, this method grows the message by aLength bytes.

Parameters

[in]	aBuf	A pointer to a data buffer.
[in]	aLength	The number of bytes to append.

Return values

OT_ERROR_NONE	Successfully appended the bytes.
OT_ERROR_NO_BUFS	Insufficient available buffers to grow the message.

§ ClearChildMask()

void ot::Message::ClearChildMask ( uint8_t aChildIndex )

This method unschedules forwarding of the message to the child.

Parameters

[in] aChildIndex The index into the child table.

§ Clone() [1/2]

Message * ot::Message::Clone ( uint16_t aLength ) const

This method creates a copy of the current Message.

It allocates the new one from the same Message Poll as the original Message and copies aLength octets of a payload.

The Type, SubType, LinkSecurity and Priority fields on the cloned message are also copied from the original one.

Parameters

[in] aLength Number of payload bytes to copy.

Returns: A pointer to the message or NULL if insufficient message buffers are available.

§ Clone() [2/2]

Message* ot::Message::Clone ( void ) const

inline

This method creates a copy of the current Message.

It allocates the new one from the same Message Poll as the original Message and copies a full payload.

Returns: A pointer to the message or NULL if insufficient message buffers are available.

§ CopyTo()

int ot::Message::CopyTo	(	uint16_t	aSourceOffset,
		uint16_t	aDestinationOffset,
		uint16_t	aLength,
		Message &	aMessage
	)		const

This method copies bytes from one message to another.

Parameters

[in]	aSourceOffset	Byte offset within the source message to begin reading.
[in]	aDestinationOffset	Byte offset within the destination message to begin writing.
[in]	aLength	Number of bytes to copy.
[in]	aMessage	Message to copy to.

Returns: The number of bytes copied.

§ GetAverageRss()

int8_t ot::Message::GetAverageRss ( void ) const

inline

This method returns the average RSS (Received Signal Strength) associated with the message.

Returns: The current average RSS value (in dBm) or OT_RADIO_RSSI_INVALID if no average is available.

§ GetChannel()

uint8_t ot::Message::GetChannel ( void ) const

inline

This method returns the IEEE 802.15.4 Channel to use for transmission.

Note: Only use this when sending MLE Announce messages.

Returns: The IEEE 802.15.4 Channel to use for transmission.

§ GetChildMask()

bool ot::Message::GetChildMask ( uint8_t aChildIndex ) const

This method returns whether or not the message forwarding is scheduled for the child.

Parameters

[in] aChildIndex The index into the child table.

Return values

TRUE	If the message is scheduled to be forwarded to the child.
FALSE	If the message is not scheduled to be forwarded to the child.

§ GetDatagramTag()

uint16_t ot::Message::GetDatagramTag ( void ) const

inline

This method returns the datagram tag used for 6LoWPAN fragmentation.

Returns: The 6LoWPAN datagram tag.

§ GetDirectTransmission()

bool ot::Message::GetDirectTransmission ( void ) const

inline

This method returns whether or not message forwarding is scheduled for direct transmission.

Return values

TRUE	If message forwarding is scheduled for direct transmission.
FALSE	If message forwarding is not scheduled for direct transmission.

§ GetInterfaceId()

int8_t ot::Message::GetInterfaceId ( void ) const

inline

This method returns the interface ID.

Returns: The interface ID.

§ GetLength()

uint16_t ot::Message::GetLength ( void ) const

inline

This method returns the number of bytes in the message.

Returns: The number of bytes in the message.

§ GetMessageQueue()

MessageQueue* ot::Message::GetMessageQueue ( void ) const

inline

This method returns a pointer to the message queue (if any) where this message is queued.

Returns: A pointer to the message queue or NULL if not in any message queue.

§ GetNext()

Message * ot::Message::GetNext ( void ) const

This method returns a pointer to the next message in the same interface list.

Returns: A pointer to the next message in the same interface list or NULL if at the end of the list.

§ GetOffset()

uint16_t ot::Message::GetOffset ( void ) const

inline

This method returns the byte offset within the message.

Returns: A byte offset within the message.

§ GetPanId()

uint16_t ot::Message::GetPanId ( void ) const

inline

This method returns the IEEE 802.15.4 Destination PAN ID.

Note: Only use this when sending MLE Discover Request or Response messages.

Returns: The IEEE 802.15.4 Destination PAN ID.

§ GetPriority()

uint8_t ot::Message::GetPriority ( void ) const

inline

This method returns the message priority level.

Returns: The priority level associated with this message.

§ GetRssAverager()

const RssAverager& ot::Message::GetRssAverager ( void ) const

inline

This method returns a const reference to RssAverager of the message.

Returns: A const reference to the RssAverager of the message.

§ GetSubType()

uint8_t ot::Message::GetSubType ( void ) const

inline

This method returns the sub type of the message.

Returns: The sub type of the message.

§ GetTimeout()

uint8_t ot::Message::GetTimeout ( void ) const

inline

This method returns the timeout used for 6LoWPAN reassembly.

Returns: The time remaining in seconds.

§ GetType()

uint8_t ot::Message::GetType ( void ) const

inline

This method returns the type of the message.

Returns: The type of the message.

§ IsChildPending()

bool ot::Message::IsChildPending ( void ) const

This method returns whether or not the message forwarding is scheduled for at least one child.

Return values

TRUE	If message forwarding is scheduled for at least one child.
FALSE	If message forwarding is not scheduled for any child.

§ IsLinkSecurityEnabled()

bool ot::Message::IsLinkSecurityEnabled ( void ) const

inline

This method indicates whether or not link security is enabled for the message.

Return values

TRUE	If link security is enabled.
FALSE	If link security is not enabled.

§ IsSubTypeMle()

bool ot::Message::IsSubTypeMle ( void ) const

This method returns whether or not the message is of MLE subtype.

Return values

TRUE	If message is of MLE subtype.
FLASE	If message is not of MLE subtype.

§ MoveOffset()

otError ot::Message::MoveOffset ( int aDelta )

This method moves the byte offset within the message.

Parameters

[in] aDelta The number of bytes to move the current offset, which may be positive or negative.

Return values

OT_ERROR_NONE	Successfully moved the byte offset.
OT_ERROR_INVALID_ARGS	The resulting byte offset is not within the existing message.

§ Prepend()

otError ot::Message::Prepend	(	const void *	aBuf,
		uint16_t	aLength
	)

This method prepends bytes to the front of the message.

On success, this method grows the message by aLength bytes.

Parameters

[in]	aBuf	A pointer to a data buffer.
[in]	aLength	The number of bytes to prepend.

Return values

OT_ERROR_NONE	Successfully prepended the bytes.
OT_ERROR_NO_BUFS	Not enough reserved bytes in the message.

§ Read()

uint16_t ot::Message::Read	(	uint16_t	aOffset,
		uint16_t	aLength,
		void *	aBuf
	)		const

This method reads bytes from the message.

Parameters

[in]	aOffset	Byte offset within the message to begin reading.
[in]	aLength	Number of bytes to read.
[in]	aBuf	A pointer to a data buffer.

Returns: The number of bytes read.

§ RemoveHeader()

otError ot::Message::RemoveHeader ( uint16_t aLength )

This method removes header bytes from the message.

Parameters

[in] aLength Number of header bytes to remove.

Return values

OT_ERROR_NONE Successfully removed header bytes from the message.

§ SetChannel()

void ot::Message::SetChannel ( uint8_t aChannel )

inline

This method sets the IEEE 802.15.4 Channel to use for transmission.

Note: Only use this when sending MLE Announce messages.

Parameters

[in] aChannel The IEEE 802.15.4 Channel to use for transmission.

§ SetChildMask()

void ot::Message::SetChildMask ( uint8_t aChildIndex )

This method schedules forwarding of the message to the child.

Parameters

[in] aChildIndex The index into the child table.

§ SetDatagramTag()

void ot::Message::SetDatagramTag ( uint16_t aTag )

inline

This method sets the datagram tag used for 6LoWPAN fragmentation.

Parameters

[in] aTag The 6LoWPAN datagram tag.

§ SetInterfaceId()

void ot::Message::SetInterfaceId ( int8_t aInterfaceId )

inline

This method sets the interface ID.

Parameters

[in] aInterfaceId The interface ID value.

§ SetLength()

otError ot::Message::SetLength ( uint16_t aLength )

This method sets the number of bytes in the message.

Parameters

[in] aLength Requested number of bytes in the message.

Return values

OT_ERROR_NONE	Successfully set the length of the message.
OT_ERROR_NO_BUFS	Failed to grow the size of the message because insufficient buffers were available.

§ SetLinkSecurityEnabled()

void ot::Message::SetLinkSecurityEnabled ( bool aEnabled )

inline

This method sets whether or not link security is enabled for the message.

Parameters

[in] aEnabled TRUE if link security is enabled, FALSE otherwise.

§ SetOffset()

otError ot::Message::SetOffset ( uint16_t aOffset )

This method sets the byte offset within the message.

Parameters

[in] aOffset The number of bytes to move the current offset, which may be positive or negative.

Return values

OT_ERROR_NONE	Successfully moved the byte offset.
OT_ERROR_INVALID_ARGS	The requested byte offset is not within the existing message.

§ SetPanId()

void ot::Message::SetPanId ( uint16_t aPanId )

inline

This method sets the IEEE 802.15.4 Destination PAN ID.

Note: Only use this when sending MLE Discover Request or Response messages.

Parameters

[in] aPanId The IEEE 802.15.4 Destination PAN ID.

§ SetPriority()

otError ot::Message::SetPriority ( uint8_t aPriority )

This method sets the messages priority.

If the message is already queued in a priority queue, changing the priority ensures to update the message in the associated queue.

Parameters

[in] aPrority The message priority level.

Return values

OT_ERROR_NONE	Successfully set the priority for the message.
OT_ERROR_INVALID_ARGS	Priority level is not invalid.

§ SetSubType()

void ot::Message::SetSubType ( uint8_t aSubType )

inline

This method sets the message sub type.

Parameters

[in] aSubType The message sub type.

§ SetTimeout()

void ot::Message::SetTimeout ( uint8_t aTimeout )

inline

This method sets the timeout used for 6LoWPAN reassembly.

Parameters

[in] aTimeout The timeout value.

§ SetType()

void ot::Message::SetType ( uint8_t aType )

inline

This method sets the message type.

Parameters

[in] aType The message type.

§ UpdateChecksum() [1/3]

uint16_t ot::Message::UpdateChecksum	(	uint16_t	aChecksum,
		uint16_t	aValue
	)

static

This static method updates a checksum.

Parameters

[in]	aChecksum	The checksum value to update.
[in]	aValue	The 16-bit value to update `aChecksum` with.

Returns: The updated checksum.

§ UpdateChecksum() [2/3]

uint16_t ot::Message::UpdateChecksum	(	uint16_t	aChecksum,
		const void *	aBuf,
		uint16_t	aLength
	)

static

This static method updates a checksum.

Parameters

[in]	aChecksum	The checksum value to update.
[in]	aBuf	A pointer to a buffer.
[in]	aLength	The number of bytes in `aBuf`.

Returns: The updated checksum.

§ UpdateChecksum() [3/3]

uint16_t ot::Message::UpdateChecksum	(	uint16_t	aChecksum,
		uint16_t	aOffset,
		uint16_t	aLength
	)		const

This method is used to update a checksum value.

Parameters

[in]	aChecksum	Initial checksum value.
[in]	aOffset	Byte offset within the message to begin checksum computation.
[in]	aLength	Number of bytes to compute the checksum over.

Return values

The	updated checksum value.

§ Write()

int ot::Message::Write	(	uint16_t	aOffset,
		uint16_t	aLength,
		const void *	aBuf
	)

This method writes bytes to the message.

Parameters

[in]	aOffset	Byte offset within the message to begin writing.
[in]	aLength	Number of bytes to write.
[in]	aBuf	A pointer to a data buffer.

Returns: The number of bytes written.

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

src/core/common/message.hpp
src/core/common/message.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

§ anonymous enum

§ anonymous enum

§ anonymous enum

Member Function Documentation

§ AddRss()

§ Append()

§ ClearChildMask()

§ Clone() [1/2]

§ Clone() [2/2]

§ CopyTo()

§ GetAverageRss()

§ GetChannel()

§ GetChildMask()

§ GetDatagramTag()

§ GetDirectTransmission()

§ GetInterfaceId()

§ GetLength()

§ GetMessageQueue()

§ GetNext()

§ GetOffset()

§ GetPanId()

§ GetPriority()

§ GetRssAverager()

§ GetSubType()

§ GetTimeout()

§ GetType()

§ IsChildPending()

§ IsLinkSecurityEnabled()

§ IsSubTypeMle()

§ MoveOffset()

§ Prepend()

§ Read()

§ RemoveHeader()

§ SetChannel()

§ SetChildMask()

§ SetDatagramTag()

§ SetInterfaceId()

§ SetLength()

§ SetLinkSecurityEnabled()

§ SetOffset()

§ SetPanId()

§ SetPriority()

§ SetSubType()

§ SetTimeout()

§ SetType()

§ UpdateChecksum() [1/3]

§ UpdateChecksum() [2/3]

§ UpdateChecksum() [3/3]

§ Write()