Border Router

This module includes functions that manage configuration parameters that apply to the Thread Border Router role. More...

Data Structures
struct	otIp6Prefix
struct	otBorderRouterConfig
struct	otExternalRouteConfig

Macros
#define	OT_NETWORK_DATA_ITERATOR_INIT   0
	Initializer for otNetworkDataIterator.

Typedefs
typedef struct otIp6Prefix	otIp6Prefix
typedef uint8_t	otNetworkDataIterator
	Used to iterate through Network Data information.
typedef struct otBorderRouterConfig	otBorderRouterConfig
typedef struct otExternalRouteConfig	otExternalRouteConfig
typedef enum otRoutePreference	otRoutePreference

Enumerations
enum	otRoutePreference { kRoutePreferenceLow = -1, kRoutePreferenceMedium = 0, kRoutePreferenceHigh = 1 }

Detailed Description

This module includes functions that manage configuration parameters that apply to the Thread Border Router role.

Typedef Documentation

typedef struct otBorderRouterConfig otBorderRouterConfig

This structure represents a Border Router configuration.

typedef struct otExternalRouteConfig otExternalRouteConfig

This structure represents an External Route configuration.

typedef struct otIp6Prefix otIp6Prefix

This structure represents an IPv6 prefix.

typedef enum otRoutePreference otRoutePreference

Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.

Enumeration Type Documentation

enum otRoutePreference

Defines valid values for member mPreference in otExternalRouteConfig and otBorderRouterConfig.

Enumerator
kRoutePreferenceLow	Routes assigned this value are used as a last resort when no other more preferred route exists.
kRoutePreferenceMedium	Routes assigned this value should be selected only in the absence of any kRoutePreferenceHigh routes.
kRoutePreferenceHigh	The most preferred route. Routes assigned this value should be selected over any other route.