nl::Weave::Profiles::WeaveTunnel::WeaveTunnelRoute

Summary

Public types

RoutePriority{
  kRoutePriority_High = 1,
  kRoutePriority_Medium = 2,
  kRoutePriority_Low = 3
}
enum
Weave Tunnel Route priority values.
RoutePriority typedef
Weave Tunnel Route priority values.

Public attributes

numOfPrefixes
uint8_t
priority[MAX_NUM_ROUTES]
uint8_t
tunnelRoutePrefix[MAX_NUM_ROUTES]
IPPrefix

Public static functions

DecodeFabricTunnelRoutes(uint64_t *fabricId, WeaveTunnelRoute *tunRoute, PacketBuffer *message)
Decode Tunnel routes containing the set of prefixes from the PacketBuffer containing the Tunnel Control message.
EncodeFabricTunnelRoutes(uint64_t fabricId, WeaveTunnelRoute *tunRoute, PacketBuffer *message)
Encode Tunnel routes containing the set of prefixes into the PacketBuffer containing the Tunnel Control message being sent.

Public types

RoutePriority

 RoutePriority

Weave Tunnel Route priority values.

Properties
kRoutePriority_High

The route priority value for high.

kRoutePriority_Low

The route priority value for low.

kRoutePriority_Medium

The route priority value for medium.

RoutePriority

enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelRoute::RoutePriority RoutePriority

Weave Tunnel Route priority values.

Public attributes

numOfPrefixes

uint8_t numOfPrefixes

priority

uint8_t priority[MAX_NUM_ROUTES]

tunnelRoutePrefix

IPPrefix tunnelRoutePrefix[MAX_NUM_ROUTES]

Public static functions

DecodeFabricTunnelRoutes

WEAVE_ERROR DecodeFabricTunnelRoutes(
  uint64_t *fabricId,
  WeaveTunnelRoute *tunRoute,
  PacketBuffer *message
)

Decode Tunnel routes containing the set of prefixes from the PacketBuffer containing the Tunnel Control message.

Details
Parameters
[out] fabricId
Fabric ID for the routes.
[out] tunRoutes
Pointer to the WeaveTunnelRoute object containing the list of prefixes.
[in] message
Pointer to the PacketBuffer from which to decode the tunnel route prefixes.
Returns
WEAVE_ERROR WEAVE_NO_ERROR on success, else error;

EncodeFabricTunnelRoutes

WEAVE_ERROR EncodeFabricTunnelRoutes(
  uint64_t fabricId,
  WeaveTunnelRoute *tunRoute,
  PacketBuffer *message
)

Encode Tunnel routes containing the set of prefixes into the PacketBuffer containing the Tunnel Control message being sent.

Encode Tunnel route containing the set of prefixes into the PacketBuffer containing the Tunnel Control message being sent.

Details
Parameters
[in] fabricId
Fabric ID for the routes.
[in] tunRoutes
Pointer to the WeaveTunnelRoute object containing the list of prefixes.
[in] message
Pointer to the PacketBuffer on which to encode the tunnel route prefixes.
Returns
WEAVE_ERROR WEAVE_NO_ERROR on success, else error;