Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Friends
dsme::DSMEMessage Class Reference

DSME Message interface implementation for GNRC. More...

Detailed Description

DSME Message interface implementation for GNRC.

Definition at line 50 of file DSMEMessage.h.

#include <DSMEMessage.h>

Public Member Functions

void prependFrom (DSMEMessageElement *msg) override
 prepend a header to current message
 
void decapsulateTo (DSMEMessageElement *msg) override
 decapsulate header to a message
 
void copyTo (DSMEMessageElement *msg)
 copy payload to DSME Message Element
 
bool hasPayload () override
 check whether the message has payload
 
uint32_t getStartOfFrameDelimiterSymbolCounter () override
 get the symbol counter at the end of the SFD
 
void setStartOfFrameDelimiterSymbolCounter (uint32_t symbolCounter) override
 set the symbol counter at the end of the SFD
 
uint16_t getTotalSymbols () override
 get the total number of symbols in current frame
 
uint8_t getMPDUSymbols () override
 get number of MPDU Symbols
 
IEEE802154eMACHeader & getHeader () override
 get IEEE 802.15.4 header
 
uint8_t getLQI () override
 get LQI of the message
 
bool getReceivedViaMCPS () override
 check whether the message was received via MCPS
 
void setReceivedViaMCPS (bool receivedViaMCPS) override
 indicated that message was received via MCPS
 
bool getCurrentlySending () override
 whether the message is being sent
 
void setCurrentlySending (bool currentlySending) override
 indicate that the message is being sent
 
void increaseRetryCounter () override
 increase retry counter for current message
 
uint8_t getRetryCounter () override
 get retry counter
 
uint8_t getPayloadLength ()
 get payload length
 
int8_t getRSSI () override
 get RSSI of frame
 
int loadBuffer (size_t len)
 preallocate buffer with a given length
 
int loadBuffer (iolist_t *pkt)
 load a GNRC packet into the internal openDSME message representation
 
uint8_t * getPayload ()
 get buffer associated to the current payload
 
int dropHdr (size_t len)
 drop a number of bytes from the header
 
void releaseMessage ()
 release the message
 
void dispatchMessage ()
 dispatch the message to upper layers
 
iolist_t * getIolPayload ()
 get the IOLIST representation of the message
 
void clearMessage ()
 clear the message
 

Data Fields

bool firstTry
 whether the message is being sent on the first try
 
bool free
 whether the message is free
 

Friends

class DSMEPlatform
 
class DSMEMessageElement
 
class DSMEPlatformBase
 
class DSMEMessageBuffer
 

Member Function Documentation

◆ getCurrentlySending()

bool dsme::DSMEMessage::getCurrentlySending ( )
inlineoverride

whether the message is being sent

Definition at line 151 of file DSMEMessage.h.

◆ getHeader()

IEEE802154eMACHeader & dsme::DSMEMessage::getHeader ( )
inlineoverride

get IEEE 802.15.4 header

Definition at line 119 of file DSMEMessage.h.

◆ getLQI()

uint8_t dsme::DSMEMessage::getLQI ( )
inlineoverride

get LQI of the message

Definition at line 127 of file DSMEMessage.h.

◆ getMPDUSymbols()

uint8_t dsme::DSMEMessage::getMPDUSymbols ( )
override

get number of MPDU Symbols

Note
not used by openDSME

◆ getPayload()

uint8_t * dsme::DSMEMessage::getPayload ( )
inline

get buffer associated to the current payload

Definition at line 210 of file DSMEMessage.h.

◆ getPayloadLength()

uint8_t dsme::DSMEMessage::getPayloadLength ( )
inline

get payload length

Definition at line 183 of file DSMEMessage.h.

◆ getReceivedViaMCPS()

bool dsme::DSMEMessage::getReceivedViaMCPS ( )
inlineoverride

check whether the message was received via MCPS

Definition at line 135 of file DSMEMessage.h.

◆ getRetryCounter()

uint8_t dsme::DSMEMessage::getRetryCounter ( )
inlineoverride

get retry counter

Definition at line 175 of file DSMEMessage.h.

◆ getRSSI()

int8_t dsme::DSMEMessage::getRSSI ( )
inlineoverride

get RSSI of frame

Definition at line 192 of file DSMEMessage.h.

◆ getStartOfFrameDelimiterSymbolCounter()

uint32_t dsme::DSMEMessage::getStartOfFrameDelimiterSymbolCounter ( )
inlineoverride

get the symbol counter at the end of the SFD

Definition at line 80 of file DSMEMessage.h.

◆ getTotalSymbols()

uint16_t dsme::DSMEMessage::getTotalSymbols ( )
inlineoverride

get the total number of symbols in current frame

Definition at line 96 of file DSMEMessage.h.

◆ hasPayload()

bool dsme::DSMEMessage::hasPayload ( )
inlineoverride

check whether the message has payload

Definition at line 72 of file DSMEMessage.h.

◆ increaseRetryCounter()

void dsme::DSMEMessage::increaseRetryCounter ( )
inlineoverride

increase retry counter for current message

Definition at line 167 of file DSMEMessage.h.

◆ setCurrentlySending()

void dsme::DSMEMessage::setCurrentlySending ( bool  currentlySending)
inlineoverride

indicate that the message is being sent

Definition at line 159 of file DSMEMessage.h.

◆ setReceivedViaMCPS()

void dsme::DSMEMessage::setReceivedViaMCPS ( bool  receivedViaMCPS)
inlineoverride

indicated that message was received via MCPS

Definition at line 143 of file DSMEMessage.h.

◆ setStartOfFrameDelimiterSymbolCounter()

void dsme::DSMEMessage::setStartOfFrameDelimiterSymbolCounter ( uint32_t  symbolCounter)
inlineoverride

set the symbol counter at the end of the SFD

Definition at line 88 of file DSMEMessage.h.

Friends And Related Symbol Documentation

◆ DSMEMessageBuffer

friend class DSMEMessageBuffer
friend

Definition at line 330 of file DSMEMessage.h.

◆ DSMEMessageElement

friend class DSMEMessageElement
friend

Definition at line 328 of file DSMEMessage.h.

◆ DSMEPlatform

friend class DSMEPlatform
friend

Definition at line 327 of file DSMEMessage.h.

◆ DSMEPlatformBase

friend class DSMEPlatformBase
friend

Definition at line 329 of file DSMEMessage.h.

Field Documentation

◆ firstTry

bool dsme::DSMEMessage::firstTry

whether the message is being sent on the first try

Definition at line 244 of file DSMEMessage.h.

◆ free

bool dsme::DSMEMessage::free

whether the message is free

Definition at line 249 of file DSMEMessage.h.

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