Inheritance diagram for ot::ThreadNetif:

Public Member Functions
	ThreadNetif (otInstance &aInstance)
	This constructor initializes the Thread network interface. More...

otError	Up (void)
	This method enables the Thread network interface.

otError	Down (void)
	This method disables the Thread network interface.

bool	IsUp (void) const
	This method indicates whether or not the Thread network interface is enabled. More...

virtual otError	GetLinkAddress (Ip6::LinkAddress &aAddress) const
	This method retrieves the link address. More...

virtual otError	SendMessage (Message &aMessage)
	This method submits a message to the network interface. More...

virtual otError	RouteLookup (const Ip6::Address &aSource, const Ip6::Address &aDestination, uint8_t *aPrefixMatch)
	This method performs a route lookup. More...

Coap::Coap &	GetCoap (void)
	This method returns a reference to the CoAP object. More...

Ip6::Filter &	GetIp6Filter (void)
	This method returns a reference to the IPv6 filter object. More...

KeyManager &	GetKeyManager (void)
	This method returns a reference to the key manager object. More...

Lowpan::Lowpan &	GetLowpan (void)
	This method returns a reference to the lowpan object. More...

Mac::Mac &	GetMac (void)
	This method returns a reference to the mac object. More...

Mle::MleRouter &	GetMle (void)
	This method returns a reference to the mle object. More...

MeshForwarder &	GetMeshForwarder (void)
	This method returns a reference to the mesh forwarder object. More...

NetworkData::Leader &	GetNetworkDataLeader (void)
	This method returns a reference to the network data leader object. More...

MeshCoP::ActiveDataset &	GetActiveDataset (void)
	This method returns a reference to the active dataset object. More...

MeshCoP::PendingDataset &	GetPendingDataset (void)
	This method returns a reference to the pending dataset object. More...

AnnounceBeginServer &	GetAnnounceBeginServer (void)
	This method returns a reference to the announce begin server object. More...

Utils::ChildSupervisor &	GetChildSupervisor (void)
	This method returns a reference to the child supervisor object. More...

Utils::SupervisionListener &	GetSupervisionListener (void)
	This method returns a reference to the supervision listener object. More...

EnergyScanServer &	GetEnergyScanServer (void)
	This method returns a reference to the energy scan server object. More...

PanIdQueryServer &	GetPanIdQueryServer (void)
	This method returns a reference to the PAN ID query server object. More...

bool	IsTmfMessage (const Ip6::MessageInfo &aMessageInfo)
	This method returns whether Thread Management Framework Addressing Rules are met. More...

Public Member Functions inherited from ot::Ip6::Netif
	Netif (otInstance &aInstance, int8_t aInterfaceId)
	This constructor initializes the network interface. More...

Netif *	GetNext (void) const
	This method returns the next network interface in the list. More...

int8_t	GetInterfaceId (void) const
	This method returns the network interface identifier. More...

const NetifUnicastAddress *	GetUnicastAddresses (void) const
	This method returns a pointer to the list of unicast addresses. More...

otError	AddUnicastAddress (NetifUnicastAddress &aAddress)
	This method adds a unicast address to the network interface. More...

otError	RemoveUnicastAddress (const NetifUnicastAddress &aAddress)
	This method removes a unicast address from the network interface. More...

otError	AddExternalUnicastAddress (const NetifUnicastAddress &aAddress)
	This method adds an external (to OpenThread) unicast address to the network interface. More...

otError	RemoveExternalUnicastAddress (const Address &aAddress)
	This method removes a external (to OpenThread) unicast address from the network interface. More...

void	RemoveAllExternalUnicastAddresses (void)
	This method removes all the previously added external (to OpenThread) unicast addresses from the network interface.

bool	IsUnicastAddress (const Address &aAddress) const
	This method indicates whether or not an address is assigned to this interface. More...

bool	IsMulticastSubscribed (const Address &aAddress) const
	This method indicates whether or not the network interface is subscribed to a multicast address. More...

otError	SubscribeAllRoutersMulticast (void)
	This method subscribes the network interface to the link-local and realm-local all routers address. More...

otError	UnsubscribeAllRoutersMulticast (void)
	This method unsubscribes the network interface to the link-local and realm-local all routers address. More...

const NetifMulticastAddress *	GetMulticastAddresses (void) const
	This method returns a pointer to the list of multicast addresses. More...

otError	SubscribeMulticast (NetifMulticastAddress &aAddress)
	This method subscribes the network interface to a multicast address. More...

otError	UnsubscribeMulticast (const NetifMulticastAddress &aAddress)
	This method unsubscribes the network interface to a multicast address. More...

otError	SubscribeExternalMulticast (const Address &aAddress)
	This method subscribes the network interface to the external (to OpenThread) multicast address. More...

otError	UnsubscribeExternalMulticast (const Address &aAddress)
	This method unsubscribes the network interface to the external (to OpenThread) multicast address. More...

void	UnsubscribeAllExternalMulticastAddresses (void)
	This method unsubscribes the network interface from all previously added external (to OpenThread) multicast addresses.

bool	IsMulticastPromiscuousEnabled (void)
	This method checks if multicast promiscuous mode is enabled on the network interface. More...

void	SetMulticastPromiscuous (bool aEnabled)
	This method enables multicast promiscuous mode on the network interface. More...

otError	RegisterCallback (NetifCallback &aCallback)
	This method registers a network interface callback. More...

otError	RemoveCallback (NetifCallback &aCallback)
	This method removes a network interface callback. More...

bool	IsStateChangedCallbackPending (void)
	This method indicates whether or not a state changed callback is pending. More...

void	SetStateChangedFlags (uint32_t aFlags)
	This method schedules notification of `aFlags`. More...

Public Member Functions inherited from ot::InstanceLocator
otInstance &	GetInstance (void) const
	This method returns a reference to the parent otInstance structure. 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...

Additional Inherited Members
Protected Member Functions inherited from ot::InstanceLocator
	InstanceLocator (otInstance &aInstance)
	This constructor initializes the object. More...

Constructor & Destructor Documentation

§ ThreadNetif()

ot::ThreadNetif::ThreadNetif ( otInstance & aInstance )

This constructor initializes the Thread network interface.

Parameters

[in] aInstance A reference to the OpenThread instance.

Member Function Documentation

§ GetActiveDataset()

MeshCoP::ActiveDataset& ot::ThreadNetif::GetActiveDataset ( void )

inline

This method returns a reference to the active dataset object.

Returns: A reference to the active dataset object.

§ GetAnnounceBeginServer()

AnnounceBeginServer& ot::ThreadNetif::GetAnnounceBeginServer ( void )

inline

This method returns a reference to the announce begin server object.

Returns: A reference to the announce begin server object.

§ GetChildSupervisor()

Utils::ChildSupervisor& ot::ThreadNetif::GetChildSupervisor ( void )

inline

This method returns a reference to the child supervisor object.

Returns: A reference to the child supervisor object.

§ GetCoap()

Coap::Coap& ot::ThreadNetif::GetCoap ( void )

inline

This method returns a reference to the CoAP object.

Returns: A reference to the CoAP object.

§ GetEnergyScanServer()

EnergyScanServer& ot::ThreadNetif::GetEnergyScanServer ( void )

inline

This method returns a reference to the energy scan server object.

Returns: A reference to the energy scan server object.

§ GetIp6Filter()

Ip6::Filter& ot::ThreadNetif::GetIp6Filter ( void )

inline

This method returns a reference to the IPv6 filter object.

Returns: A reference to the IPv6 filter object.

§ GetKeyManager()

KeyManager& ot::ThreadNetif::GetKeyManager ( void )

inline

This method returns a reference to the key manager object.

Returns: A reference to the key manager object.

§ GetLinkAddress()

otError ot::ThreadNetif::GetLinkAddress ( Ip6::LinkAddress & aAddress ) const

virtual

This method retrieves the link address.

Parameters

[out] aAddress A reference to the link address.

Implements ot::Ip6::Netif.

§ GetLowpan()

Lowpan::Lowpan& ot::ThreadNetif::GetLowpan ( void )

inline

This method returns a reference to the lowpan object.

Returns: A reference to the lowpan object.

§ GetMac()

Mac::Mac& ot::ThreadNetif::GetMac ( void )

inline

This method returns a reference to the mac object.

Returns: A reference to the mac object.

§ GetMeshForwarder()

MeshForwarder& ot::ThreadNetif::GetMeshForwarder ( void )

inline

This method returns a reference to the mesh forwarder object.

Returns: A reference to the mesh forwarder object.

§ GetMle()

Mle::MleRouter& ot::ThreadNetif::GetMle ( void )

inline

This method returns a reference to the mle object.

Returns: A reference to the mle object.

§ GetNetworkDataLeader()

NetworkData::Leader& ot::ThreadNetif::GetNetworkDataLeader ( void )

inline

This method returns a reference to the network data leader object.

Returns: A reference to the network data leader object.

§ GetPanIdQueryServer()

PanIdQueryServer& ot::ThreadNetif::GetPanIdQueryServer ( void )

inline

This method returns a reference to the PAN ID query server object.

Returns: A reference to the PAN ID query server object.

§ GetPendingDataset()

MeshCoP::PendingDataset& ot::ThreadNetif::GetPendingDataset ( void )

inline

This method returns a reference to the pending dataset object.

Returns: A reference to the pending dataset object.

§ GetSupervisionListener()

Utils::SupervisionListener& ot::ThreadNetif::GetSupervisionListener ( void )

inline

This method returns a reference to the supervision listener object.

Returns: A reference to the supervision listener object.

§ IsTmfMessage()

bool ot::ThreadNetif::IsTmfMessage ( const Ip6::MessageInfo & aMessageInfo )

This method returns whether Thread Management Framework Addressing Rules are met.

Return values

TRUE	if Thread Management Framework Addressing Rules are met.
FALSE	if Thread Management Framework Addressing Rules are not met.

§ IsUp()

bool ot::ThreadNetif::IsUp ( void ) const

inline

This method indicates whether or not the Thread network interface is enabled.

Return values

TRUE	If the Thread network interface is enabled.
FALSE	If the Thread network interface is not enabled.

§ RouteLookup()

otError ot::ThreadNetif::RouteLookup	(	const Ip6::Address &	aSource,
		const Ip6::Address &	aDestination,
		uint8_t *	aPrefixMatch
	)

virtual

This method performs a route lookup.

Parameters

[in]	aSource	A reference to the IPv6 source address.
[in]	aDestination	A reference to the IPv6 destination address.
[out]	aPrefixMatch	A pointer where the number of prefix match bits for the chosen route is stored.

Return values

OT_ERROR_NONE	Successfully found a route.
OT_ERROR_NO_ROUTE	Could not find a valid route.

Implements ot::Ip6::Netif.

§ SendMessage()

virtual otError ot::ThreadNetif::SendMessage ( Message & aMessage )

inlinevirtual

This method submits a message to the network interface.

Parameters

[in] aMessage A reference to the message.

Return values

OT_ERROR_NONE Successfully submitted the message to the interface.

Implements ot::Ip6::Netif.

The documentation for this class was generated from the following files:

src/core/thread/thread_netif.hpp
src/core/thread/thread_netif.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

§ ThreadNetif()

Member Function Documentation

§ GetActiveDataset()

§ GetAnnounceBeginServer()

§ GetChildSupervisor()

§ GetCoap()

§ GetEnergyScanServer()

§ GetIp6Filter()

§ GetKeyManager()

§ GetLinkAddress()

§ GetLowpan()

§ GetMac()

§ GetMeshForwarder()

§ GetMle()

§ GetNetworkDataLeader()

§ GetPanIdQueryServer()

§ GetPendingDataset()

§ GetSupervisionListener()

§ IsTmfMessage()

§ IsUp()

§ RouteLookup()

§ SendMessage()