nl::Weave::Profiles::WeaveTunnel::Platform

Platform provided Weave Addressing and Routing routines.

Summary

Enumerations
`TunnelAvailabilityMode{ kMode_Primary = 1, kMode_PrimaryAndBackup = 2, kMode_BackupOnly = 3 }`	enum The set of states for Weave tunnel availability.

Typedefs
`TunnelAvailabilityMode`	typedef `enum nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode` The set of states for Weave tunnel availability.

Functions
`DisableBorderRouting(void)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to disable Border Routing through Warm.
`EnableBorderRouting(void)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to enable Border Routing through Warm.
`ServiceTunnelDisconnected(InterfaceId tunIf)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to announce a tunnel interface disconnection.
`ServiceTunnelEstablished(InterfaceId tunIf, TunnelAvailabilityMode tunMode)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to announce a tunnel interface connection.
`ServiceTunnelModeChange(InterfaceId tunIf, TunnelAvailabilityMode tunMode)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to announce a Tunnel availability change.
`TunnelInterfaceDown(InterfaceId tunIf)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to announce the tunnel interface is disabled.
`TunnelInterfaceUp(InterfaceId tunIf)`	`void` A TunnelAgent Platform API implementation used by the Tunnel Agent to announce the tunnel interface is enabled.

 TunnelAvailabilityMode

The set of states for Weave tunnel availability.

Properties
`kMode_BackupOnly`	Set when the Weave Service Tunnel is available over the backup interface only.
`kMode_Primary`	Set when the Weave Service Tunnel is available over the primary interface.
`kMode_PrimaryAndBackup`	Set when the Weave Service Tunnel is available over both priary and backup interface.

enum nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode TunnelAvailabilityMode

The set of states for Weave tunnel availability.

void DisableBorderRouting(
  void
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to disable Border Routing through Warm.

Disable Border Routing at the platform level.

void EnableBorderRouting(
  void
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to enable Border Routing through Warm.

Enable Border Routing at the platform level.

void ServiceTunnelDisconnected(
  InterfaceId tunIf
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to announce a tunnel interface disconnection.

Details

Parameters

[in] tunIf

The InterfaceId for the tunnel Interface. Not used in this implementation.

void ServiceTunnelEstablished(
  InterfaceId tunIf,
  TunnelAvailabilityMode tunMode
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to announce a tunnel interface connection.

Details

Parameters

`[in] tunIf`	The InterfaceId for the tunnel Interface. Not used in this implementation.
`[in] tunMode`	The initial tunnel availability mode to be adopted by Warm.

void ServiceTunnelModeChange(
  InterfaceId tunIf,
  TunnelAvailabilityMode tunMode
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to announce a Tunnel availability change.

Perform address and route assignment tasks when the Service tunnel connection avalability state changes.

Details

Parameters

`[in] tunIf`	The InterfaceId for the tunnel Interface. Not used in this implementation.
`[in] tunMode`	The new tunnel availability mode to be adopted by Warm.

void TunnelInterfaceDown(
  InterfaceId tunIf
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to announce the tunnel interface is disabled.

Details

Parameters

[in] tunIf

The InterfaceId for the tunnel Interface. Not used in this implementation.

void TunnelInterfaceUp(
  InterfaceId tunIf
)

A TunnelAgent Platform API implementation used by the Tunnel Agent to announce the tunnel interface is enabled.

Details

Parameters

[in] tunIf

The InterfaceId for the tunnel Interface. Not used in this implementation.