FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
VOM::route::path Class Reference

A path for IP or MPLS routes. More...

Data Structures

class  flags_t
 Path flags. More...
 
class  special_t
 Special path types. More...
 

Public Member Functions

 path (special_t special)
 constructor for special paths More...
 
 path (const boost::asio::ip::address &nh, const interface &interface, uint8_t weight=1, uint8_t preference=0)
 Constructor for standard non-recursive paths. More...
 
 path (const route_domain &rd, const boost::asio::ip::address &nh, uint8_t weight=1, uint8_t preference=0)
 Constructor for standard recursive paths. More...
 
 path (const interface &interface, const nh_proto_t &proto, const flags_t &flags=flags_t::NONE, uint8_t weight=1, uint8_t preference=0)
 Constructor for DVR paths or attached paths. More...
 
 path (const path &p)
 Copy Constructor. More...
 
 ~path ()
 Destructor. More...
 
bool operator== (const path &p) const
 comparison operator More...
 
bool operator< (const path &p) const
 Less than operator for set insertion. More...
 
std::string to_string () const
 convert to string format for debug purposes More...
 
special_t type () const
 Getters. More...
 
nh_proto_t nh_proto () const
 
flags_t flags () const
 
const boost::asio::ip::address & nh () const
 
std::shared_ptr< route_domainrd () const
 
std::shared_ptr< interfaceitf () const
 
uint8_t weight () const
 
uint8_t preference () const
 

Detailed Description

A path for IP or MPLS routes.

Definition at line 32 of file route.hpp.

Constructor & Destructor Documentation

VOM::route::path::path ( special_t  special)

constructor for special paths

Definition at line 44 of file route.cpp.

VOM::route::path::path ( const boost::asio::ip::address &  nh,
const interface interface,
uint8_t  weight = 1,
uint8_t  preference = 0 
)

Constructor for standard non-recursive paths.

Definition at line 56 of file route.cpp.

VOM::route::path::path ( const route_domain rd,
const boost::asio::ip::address &  nh,
uint8_t  weight = 1,
uint8_t  preference = 0 
)

Constructor for standard recursive paths.

Definition at line 71 of file route.cpp.

VOM::route::path::path ( const interface interface,
const nh_proto_t proto,
const flags_t flags = flags_t::NONE,
uint8_t  weight = 1,
uint8_t  preference = 0 
)

Constructor for DVR paths or attached paths.

Definition at line 86 of file route.cpp.

VOM::route::path::path ( const path p)

Copy Constructor.

Definition at line 102 of file route.cpp.

VOM::route::path::~path ( )

Destructor.

Definition at line 141 of file route.cpp.

Member Function Documentation

path::flags_t VOM::route::path::flags ( ) const

Definition at line 198 of file route.cpp.

+ Here is the caller graph for this function:

std::shared_ptr< interface > VOM::route::path::itf ( ) const

Definition at line 216 of file route.cpp.

+ Here is the caller graph for this function:

const boost::asio::ip::address & VOM::route::path::nh ( ) const

Definition at line 204 of file route.cpp.

+ Here is the caller graph for this function:

nh_proto_t VOM::route::path::nh_proto ( ) const

Definition at line 192 of file route.cpp.

bool VOM::route::path::operator< ( const path p) const

Less than operator for set insertion.

Definition at line 115 of file route.cpp.

bool VOM::route::path::operator== ( const path p) const

comparison operator

Definition at line 146 of file route.cpp.

uint8_t VOM::route::path::preference ( ) const

Definition at line 228 of file route.cpp.

+ Here is the caller graph for this function:

std::shared_ptr< route_domain > VOM::route::path::rd ( ) const

Definition at line 210 of file route.cpp.

+ Here is the caller graph for this function:

std::string VOM::route::path::to_string ( void  ) const

convert to string format for debug purposes

Definition at line 166 of file route.cpp.

+ Here is the call graph for this function:

path::special_t VOM::route::path::type ( ) const

Getters.

Definition at line 186 of file route.cpp.

+ Here is the caller graph for this function:

uint8_t VOM::route::path::weight ( ) const

Definition at line 222 of file route.cpp.

+ Here is the caller graph for this function:


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