0.01.00
Public Member Functions | Protected Member Functions | List of all members
ot::InstanceLocator Class Reference
Core-locator

This class implements a locator for an OpenThread Instance object. More...

#include <src/core/common/locator.hpp>

Inheritance diagram for ot::InstanceLocator:
ot::AddressResolver ot::AnnounceBeginClient ot::AnnounceBeginServer ot::Coap::CoapBase ot::DataPollManager ot::Dhcp6::Dhcp6Client ot::Dhcp6::Dhcp6Server ot::EnergyScanClient ot::EnergyScanServer ot::Ip6::Icmp ot::Ip6::Ip6 ot::Ip6::Mpl ot::Ip6::Netif ot::Ip6::Routes ot::Ip6::Udp ot::KeyManager ot::Lowpan::Lowpan ot::Mac::Mac ot::MeshCoP::Commissioner ot::MeshCoP::DatasetLocal ot::MeshCoP::DatasetManager ot::MeshCoP::Dtls ot::MeshCoP::Joiner ot::MeshCoP::JoinerRouter ot::MeshCoP::Leader ot::MeshForwarder ot::MessagePool ot::Mle::Mle ot::NetworkData::NetworkData ot::NetworkDiagnostic::NetworkDiagnostic ot::Notifier ot::PanIdQueryClient ot::PanIdQueryServer ot::SourceMatchController ot::Tasklet ot::Timer ot::TimerScheduler ot::Utils::JamDetector

Public Member Functions

Instance & GetInstance (void) const
 This method returns a reference to the parent OpenThread Instance. More...
 
Ip6::Ip6 & GetIp6 (void) const
 This method returns a reference to the Ip6. More...
 
ThreadNetif & GetNetif (void) const
 This method returns a reference to the thread network interface. More...
 
Notifier & GetNotifier (void) const
 This method returns a reference to the Notifier. More...
 

Protected Member Functions

 InstanceLocator (Instance &aInstance)
 This constructor initializes the object. More...
 

Detailed Description

This class implements a locator for an OpenThread Instance object.

The InstanceLocator is used as base class of almost all other OpenThread classes. It provides a way for an object to get to its owning/parent OpenThread Instance and other objects within the OpenTread hierarchy (e.g. the ThreadNetif or Ip6::Ip6 objects).

If multiple-instance feature is supported, the owning/parent OpenThread Instance is tracked as a reference. In the single-instance case, this class becomes an empty base class.

Constructor & Destructor Documentation

§ InstanceLocator()

ot::InstanceLocator::InstanceLocator ( Instance &  aInstance)
inlineprotected

This constructor initializes the object.

Parameters
[in]aInstanceA pointer to the otInstance.

Member Function Documentation

§ GetInstance()

Instance & ot::InstanceLocator::GetInstance ( void  ) const

This method returns a reference to the parent OpenThread Instance.

Returns
A reference to the parent otInstance.

§ GetIp6()

Ip6::Ip6 & ot::InstanceLocator::GetIp6 ( void  ) const

This method returns a reference to the Ip6.

Returns
A reference to the Ip6.

§ GetNetif()

ThreadNetif & ot::InstanceLocator::GetNetif ( void  ) const

This method returns a reference to the thread network interface.

Returns
A reference to the thread network interface.

§ GetNotifier()

Notifier & ot::InstanceLocator::GetNotifier ( void  ) const

This method returns a reference to the Notifier.

Returns
A reference to the Notifier.
The documentation for this class was generated from the following files: