OpenSDN source code
AgentRoutePrefix< PrefixType > Class Template Reference

This class defines interfaces for manipulating the prefix of a route stored in an Agent VRF table. More...

#include <agent_route.h>

Public Member Functions

 AgentRoutePrefix (const PrefixType &new_prefix, uint8_t new_plen)
 Creates a new route prefix. More...
 
 ~AgentRoutePrefix ()
 The destructor of a route prefix. More...
 
virtual const PrefixType & prefix_address () const
 Returns the value of a stored prefix address (IPv4, IPv6 or MAC address) More...
 
void set_prefix_length (uint8_t new_plen)
 Sets the length of a stored prefix address. More...
 

Protected Attributes

PrefixType prefix_address_
 The prefix address. More...
 
uint8_t prefix_length_
 The prefix length. More...
 

Private Member Functions

 AgentRoutePrefix ()
 Forbid default ctor. More...
 
 DISALLOW_COPY_AND_ASSIGN (AgentRoutePrefix)
 

Detailed Description

template<class PrefixType>
class AgentRoutePrefix< PrefixType >

This class defines interfaces for manipulating the prefix of a route stored in an Agent VRF table.

Definition at line 377 of file agent_route.h.

Constructor & Destructor Documentation

◆ AgentRoutePrefix() [1/2]

template<class PrefixType >
AgentRoutePrefix< PrefixType >::AgentRoutePrefix ( const PrefixType &  new_prefix,
uint8_t  new_plen 
)
inline

Creates a new route prefix.

Definition at line 381 of file agent_route.h.

◆ ~AgentRoutePrefix()

template<class PrefixType >
AgentRoutePrefix< PrefixType >::~AgentRoutePrefix ( )
inline

The destructor of a route prefix.

Definition at line 385 of file agent_route.h.

◆ AgentRoutePrefix() [2/2]

template<class PrefixType >
AgentRoutePrefix< PrefixType >::AgentRoutePrefix ( )
private

Forbid default ctor.

Member Function Documentation

◆ DISALLOW_COPY_AND_ASSIGN()

template<class PrefixType >
AgentRoutePrefix< PrefixType >::DISALLOW_COPY_AND_ASSIGN ( AgentRoutePrefix< PrefixType >  )
private

◆ prefix_address()

template<class PrefixType >
virtual const PrefixType& AgentRoutePrefix< PrefixType >::prefix_address ( ) const
inlinevirtual

Returns the value of a stored prefix address (IPv4, IPv6 or MAC address)

Definition at line 389 of file agent_route.h.

◆ set_prefix_length()

template<class PrefixType >
void AgentRoutePrefix< PrefixType >::set_prefix_length ( uint8_t  new_plen)
inline

Sets the length of a stored prefix address.

Definition at line 392 of file agent_route.h.

Member Data Documentation

◆ prefix_address_

template<class PrefixType >
PrefixType AgentRoutePrefix< PrefixType >::prefix_address_
protected

The prefix address.

Definition at line 399 of file agent_route.h.

◆ prefix_length_

template<class PrefixType >
uint8_t AgentRoutePrefix< PrefixType >::prefix_length_
protected

The prefix length.

Definition at line 402 of file agent_route.h.


The documentation for this class was generated from the following file: