provider.hpp

#ifndef HAVE_TOM_TSDB_PROVIDER_HPP
#define HAVE_TOM_TSDB_PROVIDER_HPP
 
#include <tom-util/scalar.hpp>
#include <tom-util/xml_config.hpp>
#include <ostream>
#include <tom-tsdb/smart_pointers.hpp>
 
namespace tom {
 
  class dynamic_library;
 
  namespace tsdb {
 
    class provider;
    class session;
 
  }
 
}
 
// mod_<provider> backend structures/typdefs/macros
extern "C" {
 
    /* 
     * This is the prototype for the method to produce a session w/in a module!
     */
    typedef tom::tsdb::session_sptr (*factory_method)( const tom::tsdb::provider &, const tom::String & );
    typedef bool                    (*init_method)( void );
    typedef void                    (*fini_method)( void );
 
    /*
     * This is the struct that contains info about a backend provider
     */
    typedef struct TOM_UTIL_API tom_tsdb_provider_
    {
        const char *    tsdb_library_version;   // use macro below for this...
        const char *    module_version;         // use mod pkg version string
        const char *    description;            // short description about the provider
        const char *    bug_report;             // email where bug reports can be sent
        
        factory_method  factory;                // fctn ptr to create a session!
        init_method     init;                   // init the module ...can be null
        fini_method     finish;                 // finish the module...can be null
        const char *    xml_template;           // sample xml config
    } tom_tsdb_provider;
 
#define TSDB_LIBRARY_VERSION "1.0.43"
 
}
 
namespace tom {
 
  namespace tsdb {
 
 
    class TOM_UTIL_API provider
    {
    public:
        provider( );
        provider( tom::String name, tom::dynamic_library *lib );
        virtual ~provider();
 
        const char *
        name() const;
 
        const char *
        description() const;
 
        const char *
        bug_report() const;
 
        const char *
        version() const;
 
        const char *
        tsdb_version() const;
 
        const char *
        xml_config_template() const;
 
        session_sptr
        get_session( const tom::String &repo );
 
        virtual
        std::ostream &
        describe( std::ostream & ) const;
 
    protected:
        void 
        check_for_correct_version();
 
    private:
        tom::dynamic_library *  m_library;
        tom::string             m_name;
        tom_tsdb_provider *     m_provider;
        init_method             m_init;
        fini_method             m_finish;
        factory_method          m_factory;
    };
 
    TOM_UTIL_API 
    inline
    std::ostream &
    operator<<( std::ostream &os, const tom::tsdb::provider &p )
    {
        return p.describe( os );
    }
 
  } // end tsdb namespace
 
} // end tom namespace
 
#endif