FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
VOM::igmp_binding Class Reference

A representation of IGMP binding on an interface. More...

+ Inheritance diagram for VOM::igmp_binding:
+ Collaboration diagram for VOM::igmp_binding:

Public Types

typedef interface::key_t key_t
 A binding is tied to a given interface, hence its key is that of the interface. More...
 

Public Member Functions

 igmp_binding (const interface &itf)
 Construct a new object matching the desried state. More...
 
 igmp_binding (const igmp_binding &o)
 Copy Constructor. More...
 
 ~igmp_binding ()
 Destructor. More...
 
bool operator== (const igmp_binding &l) const
 Equal operator. More...
 
const key_t key () const
 Get the object's key. More...
 
std::shared_ptr< igmp_bindingsingular () const
 Return the 'singular' of the IGMP binding that matches this object. More...
 
std::string to_string () const
 convert to string format for debug purposes More...
 
std::shared_ptr< interfaceitf () const
 Return the matching'singular' of the interface. More...
 

Static Public Member Functions

static void dump (std::ostream &os)
 Dump all IGMP bindings into the stream provided. More...
 
static std::shared_ptr< igmp_bindingfind (const key_t &k)
 Find a listen from its key. More...
 

Friends

class OM
 
class singular_db< key_t, igmp_binding >
 It's the singular_db class that calls replay() More...
 

Additional Inherited Members

- Protected Member Functions inherited from VOM::object_base
 object_base ()=default
 Constructable by derived classes only. More...
 
virtual ~object_base ()=default
 Destructor. More...
 

Detailed Description

A representation of IGMP binding on an interface.

Definition at line 30 of file igmp_binding.hpp.

Member Typedef Documentation

◆ key_t

A binding is tied to a given interface, hence its key is that of the interface.

Definition at line 37 of file igmp_binding.hpp.

Constructor & Destructor Documentation

◆ igmp_binding() [1/2]

VOM::igmp_binding::igmp_binding ( const interface itf)

Construct a new object matching the desried state.

Definition at line 29 of file igmp_binding.cpp.

◆ igmp_binding() [2/2]

VOM::igmp_binding::igmp_binding ( const igmp_binding o)

Copy Constructor.

Definition at line 35 of file igmp_binding.cpp.

◆ ~igmp_binding()

VOM::igmp_binding::~igmp_binding ( )

Destructor.

Definition at line 41 of file igmp_binding.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ dump()

void VOM::igmp_binding::dump ( std::ostream &  os)
static

Dump all IGMP bindings into the stream provided.

Definition at line 69 of file igmp_binding.cpp.

+ Here is the call graph for this function:

◆ find()

std::shared_ptr< igmp_binding > VOM::igmp_binding::find ( const key_t k)
static

Find a listen from its key.

Definition at line 109 of file igmp_binding.cpp.

◆ itf()

std::shared_ptr< interface > VOM::igmp_binding::itf ( ) const

Return the matching'singular' of the interface.

Definition at line 121 of file igmp_binding.cpp.

+ Here is the call graph for this function:

◆ key()

const igmp_binding::key_t VOM::igmp_binding::key ( ) const

Get the object's key.

Definition at line 54 of file igmp_binding.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator==()

bool VOM::igmp_binding::operator== ( const igmp_binding l) const

Equal operator.

Definition at line 48 of file igmp_binding.cpp.

◆ singular()

std::shared_ptr< igmp_binding > VOM::igmp_binding::singular ( ) const

Return the 'singular' of the IGMP binding that matches this object.

Definition at line 115 of file igmp_binding.cpp.

◆ to_string()

std::string VOM::igmp_binding::to_string ( void  ) const
virtual

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 83 of file igmp_binding.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ OM

friend class OM
friend

Definition at line 138 of file igmp_binding.hpp.

◆ singular_db< key_t, igmp_binding >

friend class singular_db< key_t, igmp_binding >
friend

It's the singular_db class that calls replay()

Definition at line 143 of file igmp_binding.hpp.


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