|
| ||||||||||||||||
| RouteMetaData (const RouteMetaData& metadata)
| RouteMetaData |
| RouteMetaData ()
| RouteMetaData |
| ~RouteMetaData ()
| ~RouteMetaData |
| inline bool in_use ()
| in_use |
[const]
Returns: whether or not this route is in use. "in use" here does not mean the route won the decision process, but rather that it was at least a contender for decision, and was not filtered in the incoming filter bank.
| void set_in_use (bool used)
| set_in_use |
Record whether or not this route is in use. "in use" here does not mean the route won the decision process, but rather that it was at least a contender for decision, and was not filtered in the incoming filter bank.
Parameters:
| used | true if the route is "in use". |
| inline bool is_winner ()
| is_winner |
[const]
returns true if the route was chosen by the routing decision process as the winning route for this subnet.
is_winner should NOT be called by anything other than the DecisionTable because caching means that it may not return the right answer anywhere else
| void set_is_winner (uint32_t igp_metric)
| set_is_winner |
when a route is chosen by the routing decision process as the winning route for this subnet, set_is_winner should be called to record this fact and to record the igp_metric at the time the route was chosen.
set_is_winner should NOT be called by anything other than the DecisionTable because caching means that it may not return the right answer anywhere else
| inline void set_is_not_winner ()
| set_is_not_winner |
when a route fails to be chosen by the routing decision process as the winning route for this subnet, set_is_not_winner should be called to record this fact.
| void set_nexthop_resolved (bool resolvable)
| set_nexthop_resolved |
record whether or not a route's nexthop resolved
| inline bool nexthop_resolved ()
| nexthop_resolved |
[const]
did the route's nexthop resolve when it was passed through the NextHop resolver table.
| inline bool is_filtered ()
| is_filtered |
[const]
is_filtered returns true if the route was filtered out by the incoming filter bank, false otherwise. As such it only makes sense calling this on routes that are stored in the RibIn.
| void set_filtered (bool filtered)
| set_filtered |
set_filtered record whether or not the route was filtered out by the incoming filter bank. As such it only makes sense calling this on routes that are stored in the RibIn.
Parameters:
| filtered | true if the route was filtered, false otherwise. |
| inline bool is_deleted ()
| is_deleted |
[const]
is_deleted returns true if the route has already been deleted (but the class instance representing it has not been because it's reference count is non-zero)
| inline void set_deleted ()
| set_deleted |
| inline uint32_t igp_metric ()
| igp_metric |
[const]
Returns: the IGP routing protocol metric that applied when the route won the decision process. If the route has not won, this value is undefined.
| inline void set_igp_metric (uint32_t igp_metric)
| set_igp_metric |
| inline void dont_aggregate ()
| dont_aggregate |
| inline uint16_t refcount ()
| refcount |
[const]
| inline void reset_flags ()
| reset_flags |
| inline const PolicyTags& policytags ()
| policytags |
[const]
Returns: policy tags associated with route.
| inline void set_policytags (const PolicyTags& tags)
| set_policytags |
Replaced policy tags of route.
Parameters:
| tags | new policy tags for route. |
| inline const RefPf& policyfilter (uint32_t i)
| policyfilter |
[const]
| inline void set_policyfilter (uint32_t i, const RefPf& pf)
| set_policyfilter |
| void set_aggr_brief_mode ()
| set_aggr_brief_mode |
Set the "brief" mode flag on an candidate for aggregation.
| void clear_aggr_brief_mode ()
| clear_aggr_brief_mode |
Clear the "brief" mode flag on an candidate for aggregation.
| bool aggr_brief_mode ()
| aggr_brief_mode |
[const]
Read the "brief" aggregation mode flag.
| void set_aggr_prefix_len (uint32_t preflen)
| set_aggr_prefix_len |
Set the target prefix length on an candidate for aggregation. The field is also used for storing aggregation markers.
Parameters:
| preflen | prefix length of the requested aggregate route. |
| uint32_t aggr_prefix_len ()
| aggr_prefix_len |
[const]
Read the aggregation prefix length marker. The field is also used for storing aggregation markers.
| bool bump_refcount (int delta)
| bump_refcount |
