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 More...
 
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_tgetIolPayload ()
 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

◆ getMPDUSymbols()

uint8_t dsme::DSMEMessage::getMPDUSymbols ( )
override

get number of MPDU Symbols

Note
not used by openDSME

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