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

A DB storing the objects that each owner/key owns. More...

Public Types

typedef const std::string key_t
 In the opflex world each entity is known by a URI which can be converted into a string. More...
 

Public Member Functions

object_ref_listfind (const key_t &k)
 Find the objects owned by the key. More...
 
void flush (const key_t &k)
 flush, i.e. More...
 
void dump (const key_t &key, std::ostream &os)
 Print each of the object in the DB into the stream provided. More...
 
void dump (std::ostream &os)
 Print each KEY. More...
 

Detailed Description

A DB storing the objects that each owner/key owns.

Each object is reference counter by each key that owns it. When no more references exist the object is destroyed.

Definition at line 39 of file client_db.hpp.

Member Typedef Documentation

◆ key_t

typedef const std::string VOM::client_db::key_t

In the opflex world each entity is known by a URI which can be converted into a string.

We use the string type, since it allows us to keep this VPP specific code independent of opflex types. I might consider making this a template parameter one day...

Definition at line 51 of file client_db.hpp.

Member Function Documentation

◆ dump() [1/2]

void VOM::client_db::dump ( const key_t key,
std::ostream &  os 
)

Print each of the object in the DB into the stream provided.

Definition at line 35 of file client_db.cpp.

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

◆ dump() [2/2]

void VOM::client_db::dump ( std::ostream &  os)

Print each KEY.

Definition at line 45 of file client_db.cpp.

◆ find()

object_ref_list & VOM::client_db::find ( const key_t k)

Find the objects owned by the key.

Definition at line 20 of file client_db.cpp.

+ Here is the caller graph for this function:

◆ flush()

void VOM::client_db::flush ( const key_t k)

flush, i.e.

un-reference, all objects owned by the key

Definition at line 26 of file client_db.cpp.

+ Here is the caller graph for this function:

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