Fawkes API  Fawkes Development Version
fawkes::MongoDBConnCreator Class Referenceabstract

Interface for a MongoDB connection creator. More...

#include <>>

Inheritance diagram for fawkes::MongoDBConnCreator:

Public Member Functions

virtual mongo::DBClientBase * create_client (const char *config_name=0)=0
 Create a new MongoDB client. More...
 
virtual void delete_client (mongo::DBClientBase *client)=0
 Delete a client. More...
 

Detailed Description

Interface for a MongoDB connection creator.

Author
Tim Niemueller

Definition at line 40 of file mongodb_conncreator.h.

Member Function Documentation

◆ create_client()

virtual mongo::DBClientBase* fawkes::MongoDBConnCreator::create_client ( const char *  config_name = 0)
pure virtual

Create a new MongoDB client.

Parameters
config_nameMongoDB client configuration name for the desired connection. May be 0 in which case the default configuration is used.
Returns
MongoDB client for the given (or the default) configuration.
Exceptions
thrownif the initialization fails or the configuration for the given name does not exist.

Implemented in MongoDBThread.

Referenced by MongoLogBlackboardThread::bb_interface_created(), fawkes::MongoDBAspectIniFin::init(), and MongoLogBlackboardThread::init().

◆ delete_client()

virtual void fawkes::MongoDBConnCreator::delete_client ( mongo::DBClientBase *  client)
pure virtual

Delete a client.

Parameters
clientclient to delete

Implemented in MongoDBThread.

Referenced by fawkes::MongoDBAspectIniFin::finalize(), and MongoLogBlackboardThread::finalize().


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