ot::SourceMatchController class

Implements the "source address match" controller. The source address match feature controls how the radio layer decides the "frame pending" bit for acks sent in response to data request commands from sleepy children. Updates the source match table and also controls when to enable or disable the source matching feature. The source address match table provides the list of children for which there is a pending frame. Either a short address or an extended/long address can be added to the source address match table.

Syntax

Show:

Summary

Declaration

from src_match_controller.hpp:70

class SourceMatchController : public InstanceLocator, private NonCopyable { public: explicit SourceMatchController(Instance &aInstance); bool IsEnabled(void) const { return mEnabled; } void IncrementMessageCount(Child &aChild); void DecrementMessageCount(Child &aChild); void ResetMessageCount(Child &aChild); void SetSrcMatchAsShort(Child &aChild, bool aUseShortAddress); private: void ClearTable(void); void Enable(bool aEnable); void AddEntry(Child &aChild); void ClearEntry(Child &aChild); Error AddAddress(const Child &aChild); Error AddPendingEntries(void); bool mEnabled; };

Fields

Field

Declared as

ot::SourceMatchController::mEnabled

bool

Methods

IsEnabled() const

Returns the current state of source address matching.

IncrementMessageCount()

Increments the message count for a child and updates the source match table.

DecrementMessageCount()

Decrements the message count for a child and updates the source match table.

ResetMessageCount()

Resets the message count for a child to zero and updates the source match table.

SetSrcMatchAsShort()

Sets whether or not to perform source address matching on the extended or short address for a child.

ClearTable()

Clears the source match table.

Enable()

Enables or disables the source matching. If enabled, the radio uses the source match table to determine whether to set or clear the "frame pending" bit in an acknowledgment to a MAC Data Request command. If disabled, the radio layer sets the "frame pending" on all acknowledgment frames in response to MAC Data Request commands.

AddEntry()

Adds an entry to source match table for a given child and updates the state of source matching feature accordingly. If the entry is added successfully, source matching feature is enabled (if not already enabled) after ensuring that there are no remaining pending entries. If the entry cannot be added (no space in source match table), the child is marked to remember the pending entry and source matching is disabled.

ClearEntry()

Clears an entry in source match table for a given child and updates the state of source matching feature accordingly. If the entry is removed successfully and frees up space in the source match table, any remaining pending entries are added. If all pending entries are successfully added, source matching is enabled.