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
The set of states for Weave tunnel availability.

Functions

DisableBorderRouting(void)
void
Disable Border Routing at the platform level.
EnableBorderRouting(void)
void
Enable Border Routing at the platform level.
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
Perform address and route assignment tasks when the Service tunnel connection avalability state changes.
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.

Enumerations

TunnelAvailabilityMode

 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.

Typedefs

TunnelAvailabilityMode

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

The set of states for Weave tunnel availability.

Functions

DisableBorderRouting

void DisableBorderRouting(
  void
)

Disable Border Routing at the platform level.

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

EnableBorderRouting

void EnableBorderRouting(
  void
)

Enable Border Routing at the platform level.

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

ServiceTunnelDisconnected

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.

ServiceTunnelEstablished

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.

ServiceTunnelModeChange

void ServiceTunnelModeChange(
  InterfaceId tunIf,
  TunnelAvailabilityMode tunMode
)

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

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

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.

TunnelInterfaceDown

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.

TunnelInterfaceUp

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.