FD.io VPP  v19.08.2-294-g37e99c22d
Vector Packet Processing
VOM::rc_t Struct Reference

Error codes that VPP will return during a HW write. More...

+ Inheritance diagram for VOM::rc_t:
+ Collaboration diagram for VOM::rc_t:

Public Member Functions

 ~rc_t ()=default
 Destructor. More...
 
- Public Member Functions inherited from VOM::enum_base< rc_t >
const std::string & to_string () const
 convert to string format for debug purposes More...
 
bool operator== (const enum_base &e) const
 Comparison operator. More...
 
enum_baseoperator= (const enum_base &e)
 Assignment. More...
 
enum_baseoperator|= (const enum_base &e)
 bitwise or assignemnt More...
 
enum_base operator| (const enum_base &e1) const
 bitwise or More...
 
bool operator!= (const enum_base &e) const
 Comparison operator. More...
 
 operator int () const
 integer conversion operator More...
 
int value () const
 Return the value of the enum - same as integer conversion. More...
 

Static Public Member Functions

static const rc_tfrom_vpp_retval (int32_t rv)
 Get the rc_t from the VPP API value. More...
 

Static Public Attributes

static const rc_t UNSET
 The value un-set. More...
 
static const rc_t NOOP
 The HW write/update action was/has not been attempted. More...
 
static const rc_t OK
 The HW write was successfull. More...
 
static const rc_t INVALID
 HW write reported invalid input. More...
 
static const rc_t TIMEOUT
 HW write timedout - VPP did not respond within a timely manner. More...
 

Additional Inherited Members

- Protected Member Functions inherited from VOM::enum_base< rc_t >
 enum_base (int value, const std::string desc)
 Constructor of an enum - takes value and string description. More...
 
virtual ~enum_base ()
 Constructor. More...
 

Detailed Description

Error codes that VPP will return during a HW write.

Definition at line 89 of file types.hpp.

Constructor & Destructor Documentation

◆ ~rc_t()

VOM::rc_t::~rc_t ( )
default

Destructor.

Member Function Documentation

◆ from_vpp_retval()

const rc_t & VOM::rc_t::from_vpp_retval ( int32_t  rv)
static

Get the rc_t from the VPP API value.

Definition at line 33 of file types.cpp.

+ Here is the caller graph for this function:

Field Documentation

◆ INVALID

const rc_t VOM::rc_t::INVALID
static

HW write reported invalid input.

Definition at line 114 of file types.hpp.

◆ NOOP

const rc_t VOM::rc_t::NOOP
static

The HW write/update action was/has not been attempted.

Definition at line 104 of file types.hpp.

◆ OK

const rc_t VOM::rc_t::OK
static

The HW write was successfull.

Definition at line 109 of file types.hpp.

◆ TIMEOUT

const rc_t VOM::rc_t::TIMEOUT
static

HW write timedout - VPP did not respond within a timely manner.

Definition at line 119 of file types.hpp.

◆ UNSET

const rc_t VOM::rc_t::UNSET
static

The value un-set.

Definition at line 99 of file types.hpp.


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