mongo::Module Class Reference

#include <module.h>

List of all members.

Public Member Functions

boost::program_options::options_description_easy_init add_options ()
virtual void config (program_options::variables_map &params)=0
const string & getName ()
virtual void init ()=0
 Module (const string &name)
virtual void shutdown ()=0
virtual ~Module ()

Static Public Member Functions

static void addOptions (program_options::options_description &options)
static void configAll (program_options::variables_map &params)
static void initAll ()

Private Attributes

string _name
program_options::options_description _options

Static Private Attributes

static std::list< Module * > * _all

Detailed Description

Module is the base class for adding modules to MongoDB modules allow adding hooks and features to mongo the idea is to add hooks into the main code for module support where needed some ideas are: monitoring, indexes, full text search

Definition at line 33 of file module.h.


Constructor & Destructor Documentation

mongo::Module::Module ( const string &  name  ) 
virtual mongo::Module::~Module (  )  [virtual]

Member Function Documentation

boost::program_options::options_description_easy_init mongo::Module::add_options (  )  [inline]

Definition at line 38 of file module.h.

static void mongo::Module::addOptions ( program_options::options_description &  options  )  [static]
virtual void mongo::Module::config ( program_options::variables_map &  params  )  [pure virtual]

read config from command line

static void mongo::Module::configAll ( program_options::variables_map &  params  )  [static]
const string& mongo::Module::getName (  )  [inline]

Definition at line 57 of file module.h.

virtual void mongo::Module::init (  )  [pure virtual]

called after configuration when the server is ready start

static void mongo::Module::initAll (  )  [static]
virtual void mongo::Module::shutdown (  )  [pure virtual]

called when the database is about to shutdown


Member Data Documentation

std::list<Module*>* mongo::Module::_all [static, private]

Definition at line 66 of file module.h.

string mongo::Module::_name [private]

Definition at line 67 of file module.h.

program_options::options_description mongo::Module::_options [private]

Definition at line 68 of file module.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


mongodb
Author(s): Nate Koenig
autogenerated on Fri Jan 11 12:15:56 2013