openthread-single-instance.h File Reference

This file defines the getter functions for single instance OpenThread objects. More...

#include "openthread-core-config.h"
#include <openthread/types.h>

Go to the source code of this file.

Namespaces
	ot::Ip6
	This namespace includes definitions for IPv6 networking.

Functions
otInstance *	otGetInstance (void)
	This function returns a pointer to the single otInstance (if initialized and ready). More...
ot::ThreadNetif &	otGetThreadNetif (void)
	This function returns a reference to the single thread network interface instance. More...
ot::MeshForwarder &	otGetMeshForwarder (void)
	This function returns a reference to the single MeshForwarder instance. More...
ot::TaskletScheduler &	otGetTaskletScheduler (void)
	This function returns a reference to the single TaskletShceduler instance. More...
ot::Ip6::Ip6 &	otGetIp6 (void)
	This function returns a reference to the single Ip6 instance. More...

Detailed Description

This file defines the getter functions for single instance OpenThread objects.

Function Documentation

otGetInstance()

otInstance* otGetInstance

(

void

)

This function returns a pointer to the single otInstance (if initialized and ready).

Returns

A pointer to single otInstance structure, or NULL if the instance is not ready, i.e. either it is not yet initialized (no call to otInstanceInitSingle()) or it is finalized (call to otInstanceFinalize()).

otGetIp6()

ot::Ip6::Ip6& otGetIp6

(

void

)

This function returns a reference to the single Ip6 instance.

Returns

A reference to the Ip6 instance.

otGetMeshForwarder()

ot::MeshForwarder& otGetMeshForwarder

(

void

)

This function returns a reference to the single MeshForwarder instance.

Returns

A reference to the MeshForwarder instance.

otGetTaskletScheduler()

ot::TaskletScheduler& otGetTaskletScheduler

(

void

)

This function returns a reference to the single TaskletShceduler instance.

Returns

A reference to the TaskletShceduler instance.

otGetThreadNetif()

ot::ThreadNetif& otGetThreadNetif

(

void

)

This function returns a reference to the single thread network interface instance.

Returns

A reference to the thread network interface instance.