Symbols

loading...

Files

loading...

Summary Syntax Methods Related References

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Instance

ot::Instance class

Represents an OpenThread instance. Contains all the components used by OpenThread.

Syntax

Show:

Summary

Declaration

from instance.hpp:170

class Instance : public otInstance, private NonCopyable { public: class BufferInfo : public otBufferInfo, public Clearable<BufferInfo> { }; #if OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE static Instance *Init(void *aBuffer, size_t *aBufferSize); #if OPENTHREAD_CONFIG_MULTIPLE_STATIC_INSTANCE_ENABLE static Instance *InitMultiple(uint8_t aIdx); static Instance &Get(uint8_t aIdx); static uint8_t GetIdx(Instance *aInstance); #endif #else static Instance &InitSingle(void); static Instance &Get(void); #endif uint32_t GetId(void) const { return mId; } #if OPENTHREAD_PLATFORM_NEXUS void SetId(uint32_t aId) { mId = aId; } #endif bool IsInitialized(void) const { return mIsInitialized; } void Reset(void); #if OPENTHREAD_CONFIG_PLATFORM_BOOTLOADER_MODE_ENABLE Error ResetToBootloader(void); #endif #if OPENTHREAD_RADIO void ResetRadioStack(void); #endif static LogLevel GetLogLevel(void) #if OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE { return sLogLevel; } #else { return static_cast<LogLevel>(OPENTHREAD_CONFIG_LOG_LEVEL); } #endif #if OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE static void SetLogLevel(LogLevel aLogLevel); #endif void Finalize(void); #if OPENTHREAD_MTD || OPENTHREAD_FTD void FactoryReset(void); Error ErasePersistentInfo(void); #if !OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE static Utils::Heap &GetHeap(void); #endif #if OPENTHREAD_CONFIG_COAP_API_ENABLE Coap::Coap &GetApplicationCoap(void) { return mApplicationCoap; } #endif #if OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE Coap::CoapSecure &GetApplicationCoapSecure(void) { return mApplicationCoapSecure; } #endif #if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE static void SetDnsNameCompressionEnabled(bool aEnabled) { sDnsNameCompressionEnabled = aEnabled; } static bool IsDnsNameCompressionEnabled(void) { return sDnsNameCompressionEnabled; } #endif void GetBufferInfo(BufferInfo &aInfo); void ResetBufferInfo(void); #endif template <typename Type> inline Type &Get(void); #if OPENTHREAD_PLATFORM_NEXUS Instance(void); void AfterInit(void); #endif private: #if !OPENTHREAD_PLATFORM_NEXUS Instance(void); void AfterInit(void); #endif Tasklet::Scheduler mTaskletScheduler; TimerMilli::Scheduler mTimerMilliScheduler; #if OPENTHREAD_CONFIG_PLATFORM_USEC_TIMER_ENABLE TimerMicro::Scheduler mTimerMicroScheduler; #endif #if OPENTHREAD_MTD || OPENTHREAD_FTD #if !OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE static Utils::Heap *sHeap; #endif Crypto::MbedTls mMbedTls; #endif Random::Manager mRandomManager; Radio mRadio; #if OPENTHREAD_CONFIG_UPTIME_ENABLE Uptime mUptime; #endif #if OPENTHREAD_MTD || OPENTHREAD_FTD Notifier mNotifier; TimeTicker mTimeTicker; Settings mSettings; SettingsDriver mSettingsDriver; MessagePool mMessagePool; #if OPENTHREAD_CONFIG_PLATFORM_DNSSD_ENABLE || OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE Dnssd mDnssd; #endif Ip6::Ip6 mIp6; ThreadNetif mThreadNetif; Tmf::Agent mTmfAgent; #if OPENTHREAD_CONFIG_DHCP6_CLIENT_ENABLE Dhcp6::Client mDhcp6Client; #endif #if OPENTHREAD_CONFIG_DHCP6_SERVER_ENABLE Dhcp6::Server mDhcp6Server; #endif #if OPENTHREAD_CONFIG_NEIGHBOR_DISCOVERY_AGENT_ENABLE NeighborDiscovery::Agent mNeighborDiscoveryAgent; #endif #if OPENTHREAD_CONFIG_IP6_SLAAC_ENABLE Utils::Slaac mSlaac; #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE Dns::Client mDnsClient; #endif #if OPENTHREAD_CONFIG_SRP_CLIENT_ENABLE Srp::Client mSrpClient; #endif #if OPENTHREAD_CONFIG_SRP_CLIENT_BUFFERS_ENABLE Utils::SrpClientBuffers mSrpClientBuffers; #endif #if OPENTHREAD_CONFIG_DNSSD_SERVER_ENABLE Dns::ServiceDiscovery::Server mDnssdServer; #endif #if OPENTHREAD_CONFIG_DNS_DSO_ENABLE Dns::Dso mDnsDso; #endif #if OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE Dns::Multicast::Core mMdnsCore; #endif #if OPENTHREAD_CONFIG_SNTP_CLIENT_ENABLE Sntp::Client mSntpClient; #endif #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE BackboneRouter::Local mBackboneRouterLocal; #endif MeshCoP::ActiveDatasetManager mActiveDataset; MeshCoP::PendingDatasetManager mPendingDataset; MeshCoP::ExtendedPanIdManager mExtendedPanIdManager; MeshCoP::NetworkNameManager mNetworkNameManager; Ip6::Filter mIp6Filter; KeyManager mKeyManager; Lowpan::Lowpan mLowpan; Mac::Mac mMac; MeshForwarder mMeshForwarder; Mle::MleRouter mMleRouter; Mle::DiscoverScanner mDiscoverScanner; AddressResolver mAddressResolver; #if OPENTHREAD_CONFIG_MULTI_RADIO RadioSelector mRadioSelector; #endif #if OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE || OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE NetworkData::Local mNetworkDataLocal; #endif NetworkData::Leader mNetworkDataLeader; #if OPENTHREAD_FTD || OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE || OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE NetworkData::Notifier mNetworkDataNotifier; #endif #if OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE NetworkData::Publisher mNetworkDataPublisher; #endif NetworkData::Service::Manager mNetworkDataServiceManager; NetworkDiagnostic::Server mNetworkDiagnosticServer; #if OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE NetworkDiagnostic::Client mNetworkDiagnosticClient; #endif #if OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE MeshCoP::BorderAgent mBorderAgent; #endif #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD MeshCoP::Commissioner mCommissioner; #endif #if OPENTHREAD_CONFIG_SECURE_TRANSPORT_ENABLE Tmf::SecureAgent mTmfSecureAgent; #endif #if OPENTHREAD_CONFIG_JOINER_ENABLE MeshCoP::Joiner mJoiner; #endif #if OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE Utils::JamDetector mJamDetector; #endif #if OPENTHREAD_FTD MeshCoP::JoinerRouter mJoinerRouter; MeshCoP::Leader mLeader; #endif #if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2) BackboneRouter::Leader mBackboneRouterLeader; #endif #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE BackboneRouter::Manager mBackboneRouterManager; #endif #if OPENTHREAD_CONFIG_MLR_ENABLE || (OPENTHREAD_FTD && OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE) MlrManager mMlrManager; #endif #if OPENTHREAD_CONFIG_DUA_ENABLE || (OPENTHREAD_FTD && OPENTHREAD_CONFIG_TMF_PROXY_DUA_ENABLE) DuaManager mDuaManager; #endif #if OPENTHREAD_CONFIG_SRP_SERVER_ENABLE Srp::Server mSrpServer; #if OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE Srp::AdvertisingProxy mSrpAdvertisingProxy; #endif #endif #if OPENTHREAD_FTD ChildSupervisor mChildSupervisor; #endif SupervisionListener mSupervisionListener; AnnounceBeginServer mAnnounceBegin; PanIdQueryServer mPanIdQuery; EnergyScanServer mEnergyScan; #if OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE AnycastLocator mAnycastLocator; #endif #if OPENTHREAD_CONFIG_TIME_SYNC_ENABLE TimeSync mTimeSync; #endif #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_INITIATOR_ENABLE LinkMetrics::Initiator mInitiator; #endif #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE LinkMetrics::Subject mSubject; #endif #if OPENTHREAD_CONFIG_COAP_API_ENABLE Coap::Coap mApplicationCoap; #endif #if OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE Coap::CoapSecure mApplicationCoapSecure; #endif #if OPENTHREAD_CONFIG_BLE_TCAT_ENABLE Ble::BleSecure mApplicationBleSecure; #endif #if OPENTHREAD_CONFIG_PING_SENDER_ENABLE Utils::PingSender mPingSender; #endif #if OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE Utils::ChannelMonitor mChannelMonitor; #endif #if OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE && \ (OPENTHREAD_FTD || OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE) Utils::ChannelManager mChannelManager; #endif #if OPENTHREAD_CONFIG_MESH_DIAG_ENABLE && OPENTHREAD_FTD Utils::MeshDiag mMeshDiag; #endif #if OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE Utils::HistoryTracker mHistoryTracker; #endif #if OPENTHREAD_CONFIG_LINK_METRICS_MANAGER_ENABLE Utils::LinkMetricsManager mLinkMetricsManager; #endif #if (OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE || OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE) && OPENTHREAD_FTD MeshCoP::DatasetUpdater mDatasetUpdater; #endif #if OPENTHREAD_CONFIG_ANNOUNCE_SENDER_ENABLE AnnounceSender mAnnounceSender; #endif #if OPENTHREAD_CONFIG_OTNS_ENABLE Utils::Otns mOtns; #endif #if OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE BorderRouter::RoutingManager mRoutingManager; #endif #if OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE Nat64::Translator mNat64Translator; #endif #endif #if OPENTHREAD_RADIO || OPENTHREAD_CONFIG_LINK_RAW_ENABLE Mac::LinkRaw mLinkRaw; #endif #if OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE static LogLevel sLogLevel; #endif #if OPENTHREAD_ENABLE_VENDOR_EXTENSION Extension::ExtensionBase &mExtension; #endif #if OPENTHREAD_CONFIG_DIAG_ENABLE FactoryDiags::Diags mDiags; #endif #if OPENTHREAD_CONFIG_POWER_CALIBRATION_ENABLE && OPENTHREAD_CONFIG_PLATFORM_POWER_CALIBRATION_ENABLE Utils::PowerCalibration mPowerCalibration; #endif bool mIsInitialized; #if OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE && (OPENTHREAD_FTD || OPENTHREAD_MTD) static bool sDnsNameCompressionEnabled; #endif uint32_t mId; };

Fields

Field

Declared as

ot::Instance::mTaskletScheduler

Tasklet::Scheduler

ot::Instance::mTimerMilliScheduler

TimerMilli::Scheduler

ot::Instance::mTimerMicroScheduler

TimerMicro::Scheduler

ot::Instance::mMbedTls

Crypto::MbedTls

ot::Instance::mRandomManager

Random::Manager

ot::Instance::mRadio

ot::Instance::mUptime

ot::Instance::mNotifier

ot::Instance::mTimeTicker

ot::Instance::mSettings

ot::Instance::mSettingsDriver

ot::Instance::mMessagePool

ot::Instance::mIp6

Ip6::Ip6

ot::Instance::mThreadNetif

ot::Instance::mTmfAgent

Tmf::Agent

ot::Instance::mDhcp6Client

Dhcp6::Client

ot::Instance::mDhcp6Server

Dhcp6::Server

ot::Instance::mSlaac

Utils::Slaac

ot::Instance::mDnsClient

ot::Instance::mSrpClient

ot::Instance::mSrpClientBuffers

Utils::SrpClientBuffers

ot::Instance::mDnssdServer

Dns::ServiceDiscovery::Server

ot::Instance::mBackboneRouterLocal

BackboneRouter::Local

ot::Instance::mActiveDataset

MeshCoP::ActiveDatasetManager

ot::Instance::mPendingDataset

MeshCoP::PendingDatasetManager

ot::Instance::mExtendedPanIdManager

MeshCoP::ExtendedPanIdManager

ot::Instance::mNetworkNameManager

MeshCoP::NetworkNameManager

ot::Instance::mIp6Filter

ot::Instance::mKeyManager

ot::Instance::mLowpan

Lowpan::Lowpan

ot::Instance::mMac

Mac::Mac

ot::Instance::mMeshForwarder

ot::Instance::mMleRouter

ot::Instance::mDiscoverScanner

Mle::DiscoverScanner

ot::Instance::mAddressResolver

AddressResolver

ot::Instance::mNetworkDataLocal

NetworkData::Local

ot::Instance::mNetworkDataLeader

NetworkData::Leader

ot::Instance::mNetworkDataNotifier

NetworkData::Notifier

ot::Instance::mNetworkDataPublisher

NetworkData::Publisher

ot::Instance::mNetworkDataServiceManager

NetworkData::Service::Manager

ot::Instance::mNetworkDiagnosticServer

NetworkDiagnostic::Server

ot::Instance::mNetworkDiagnosticClient

NetworkDiagnostic::Client

ot::Instance::mBorderAgent

MeshCoP::BorderAgent

ot::Instance::mTmfSecureAgent

Tmf::SecureAgent

ot::Instance::mJoinerRouter

MeshCoP::JoinerRouter

ot::Instance::mLeader

MeshCoP::Leader

ot::Instance::mBackboneRouterLeader

BackboneRouter::Leader

ot::Instance::mBackboneRouterManager

BackboneRouter::Manager

ot::Instance::mMlrManager

ot::Instance::mDuaManager

ot::Instance::mSrpServer

ot::Instance::mChildSupervisor

ChildSupervisor

ot::Instance::mSupervisionListener

SupervisionListener

ot::Instance::mAnnounceBegin

AnnounceBeginServer

ot::Instance::mPanIdQuery

PanIdQueryServer

ot::Instance::mEnergyScan

EnergyScanServer

ot::Instance::mApplicationCoap

Coap::Coap

ot::Instance::mPingSender

Utils::PingSender

ot::Instance::mMeshDiag

Utils::MeshDiag

ot::Instance::mAnnounceSender

ot::Instance::mRoutingManager

BorderRouter::RoutingManager

ot::Instance::sLogLevel

ot::Instance::mDiags

FactoryDiags::Diags

ot::Instance::mIsInitialized

bool

ot::Instance::sDnsNameCompressionEnabled

ot::Instance::mId

uint32_t

Methods

InitSingle()

Initializes the single OpenThread instance. Initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be called before any other calls to OpenThread.

Get()

Returns a reference to the single OpenThread instance.

GetId() const

Gets the instance identifier. The instance identifier is set to a random value when the instance is constructed, and then its value will not change after initialization.

IsInitialized() const

Indicates whether or not the instance is valid/initialized and not yet finalized.

Reset()

Triggers a platform reset. The reset process ensures that all the OpenThread state/info (stored in volatile memory) is erased. Note that this method does not erase any persistent state/info saved in non-volatile memory.

GetLogLevel()

Returns the active log level.

SetLogLevel()

Sets the log level.

Finalize()

Finalizes the OpenThread instance. Should be called when OpenThread instance is no longer in use.

FactoryReset()

Deletes all the settings stored in non-volatile memory, and then triggers a platform reset.

ErasePersistentInfo()

Erases all the OpenThread persistent info (network settings) stored in non-volatile memory. Erase is successful/allowed only if the device is in `disabled` state/role.

GetApplicationCoap()

Returns a reference to application COAP object.

SetDnsNameCompressionEnabled()

Enables/disables the "DNS name compressions" mode. By default DNS name compression is enabled. When disabled, DNS names are appended as full and never compressed. This is applicable to OpenThread's DNS and SRP client/server modules. This is intended for testing only and available under a `REFERENCE_DEVICE` config.

IsDnsNameCompressionEnabled()

Indicates whether the "DNS name compression" mode is enabled or not.

GetBufferInfo()

Retrieves the the Message Buffer information.

ResetBufferInfo()

Resets the Message Buffer information counter tracking maximum number buffers in use at the same time. Resets `mMaxUsedBuffers` in `BufferInfo`.

AfterInit()

Examples

References

from examples