Symbols ![]()
loading...
Files ![]()
loading (1/5)...
ot::BackboneRouter::Local class
Implements the definitions for local Backbone Router service.
Syntax
class Local : public InstanceLocator,
private NonCopyable
{
friend class ot::TimeTicker;
public:
typedef otBackboneRouterDomainPrefixCallback DomainPrefixCallback;
enum State : uint8_t
{
kStateDisabled = OT_BACKBONE_ROUTER_STATE_DISABLED,
kStateSecondary = OT_BACKBONE_ROUTER_STATE_SECONDARY,
kStatePrimary = OT_BACKBONE_ROUTER_STATE_PRIMARY,
};
enum RegisterMode : uint8_t
{
kDecideBasedOnState,
kForceRegistration,
};
explicit Local(Instance &aInstance);
void SetEnabled(bool aEnable);
State GetState(void) const { return mState; }
void Reset(void);
void GetConfig(Config &aConfig) const;
Error SetConfig(const Config &aConfig);
Error AddService(RegisterMode aMode);
bool IsPrimary(void) const { return mState == kStatePrimary; }
bool IsEnabled(void) const { return mState != kStateDisabled; }
void SetRegistrationJitter(uint8_t aRegistrationJitter) { mRegistrationJitter = aRegistrationJitter; }
uint8_t GetRegistrationJitter(void) const { return mRegistrationJitter; }
void HandleBackboneRouterPrimaryUpdate(Leader::State aState, const Config &aConfig);
Error GetDomainPrefix(NetworkData::OnMeshPrefixConfig &aConfig);
Error RemoveDomainPrefix(const Ip6::Prefix &aPrefix);
Error SetDomainPrefix(const NetworkData::OnMeshPrefixConfig &aConfig);
const Ip6::Address &GetAllNetworkBackboneRoutersAddress(void) const { return mAllNetworkBackboneRouters; }
const Ip6::Address &GetAllDomainBackboneRoutersAddress(void) const { return mAllDomainBackboneRouters; }
void ApplyNewMeshLocalPrefix(void);
void HandleDomainPrefixUpdate(DomainPrefixEvent aEvent);
void SetDomainPrefixCallback(DomainPrefixCallback aCallback, void *aContext)
{
mDomainPrefixCallback.Set(aCallback, aContext);
}
private:
enum Action : uint8_t
{
kActionSet,
kActionAdd,
kActionRemove,
};
void SetState(State aState);
void RemoveService(void);
void HandleTimeTick(void);
void AddDomainPrefixToNetworkData(void);
void RemoveDomainPrefixFromNetworkData(void);
void IncrementSequenceNumber(void);
#if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_INFO)
static const char *ActionToString(Action aAction);
void LogService(Action aAction, Error aError);
void LogDomainPrefix(Action aAction, Error aError);
#else
void LogService(Action, Error) {}
void LogDomainPrefix(Action, Error) {}
#endif
bool mIsServiceAdded;
State mState;
uint8_t mSequenceNumber;
uint8_t mRegistrationJitter;
uint16_t mReregistrationDelay;
uint16_t mRegistrationTimeout;
uint32_t mMlrTimeout;
NetworkData::OnMeshPrefixConfig mDomainPrefixConfig;
Ip6::Netif::UnicastAddress mBbrPrimaryAloc;
Ip6::Address mAllNetworkBackboneRouters;
Ip6::Address mAllDomainBackboneRouters;
Callback<DomainPrefixCallback> mDomainPrefixCallback;
};
Fields
Field
Declared as
Callback<DomainPrefixCallback>
References
Code
Location
Scope
Referrer
Class Tree
ot::BackboneRouter::Local is inherited by 2 classess:
Instances
Instance
Scope
Location
Project