Skip to content

Commit

Permalink
[message] add API functions to enable multicast looping of a message
Browse files Browse the repository at this point in the history
At the moment, C API does not allow to get/set the configuration flag
which the message to be looped back to the Thread interface. It is
important within the context of sending already prepared IPv6 mutlicast
packets with `otIp6Send()`.
  • Loading branch information
konradderda committed Nov 15, 2023
1 parent 22fcb0e commit 691d22a
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion include/openthread/instance.h
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (371)
#define OPENTHREAD_API_VERSION (372)

/**
* @addtogroup api-instance
Expand Down
22 changes: 22 additions & 0 deletions include/openthread/message.h
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,28 @@ bool otMessageIsLoopbackToHostAllowed(const otMessage *aMessage);
*/
void otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost);

/**
* Indicates whether the given message may be looped back in a case of a multicast destination address.
*
* If @p aMessage is used along with an `otMessageInfo`, the `mMulticastLoop` field from `otMessageInfo` structure
* takes precedence and will be used instead of the the value set on @p aMessage.
*
* This API is mainly intended for use along with `otIp6Send()` which expects an already prepared IPv6 message.
*
* @param[in] aMessage A pointer to the message.
*
*/
bool otMessageIsMulticastLoopEnabled(otMessage *aMessage);

/**
* Controls whether the given message may be looped back in a case of a multicast destination address.
*
* @param[in] aMessage A pointer to the message.
* @param[in] aEnabled The configuration value.
*
*/
void otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled);

/**
* Gets the message origin.
*
Expand Down
7 changes: 7 additions & 0 deletions src/core/api/message_api.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ void otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackT
return AsCoreType(aMessage).SetLoopbackToHostAllowed(aAllowLoopbackToHost);
}

bool otMessageIsMulticastLoopEnabled(otMessage *aMessage) { return AsCoreType(aMessage).GetMulticastLoop(); }

void otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
{
AsCoreType(aMessage).SetMulticastLoop(aEnabled);
}

otMessageOrigin otMessageGetOrigin(const otMessage *aMessage) { return MapEnum(AsCoreType(aMessage).GetOrigin()); }

void otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
Expand Down

0 comments on commit 691d22a

Please sign in to comment.