NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CDBAPI_CacheAdmin Class Reference

Search Toolkit Book for CDBAPI_CacheAdmin

DBAPI cache administration tool. More...

+ Inheritance diagram for CDBAPI_CacheAdmin:
+ Collaboration diagram for CDBAPI_CacheAdmin:

Public Member Functions

void Init (void)
 Initialize the application. More...
int Run (void)
 Run the application. More...
- Public Member Functions inherited from CNcbiApplication
 CNcbiApplication (void)
 Constructor. More...
virtual ~CNcbiApplication (void)
 Destructor. More...
int AppMain (int argc, const char *const *argv, const char *const *envp=0, EAppDiagStream diag=eDS_Default, const char *conf=NcbiEmptyCStr, const string &name=NcbiEmptyString)
 Main function (entry point) for the NCBI application. More...
virtual int DryRun (void)
 Test run the application. More...
virtual void Exit (void)
 Cleanup on application exit. More...
const CNcbiArgumentsGetArguments (void) const
 Get the application's cached unprocessed command-line arguments. More...
virtual const CArgsGetArgs (void) const
 Get parsed command line arguments. More...
const CNcbiEnvironmentGetEnvironment (void) const
 Get the application's cached environment. More...
CNcbiEnvironmentSetEnvironment (void)
 Get a non-const copy of the application's cached environment. More...
void SetEnvironment (const string &name, const string &value)
 Set a specified environment variable by name. More...
bool HasLoadedConfig (void) const
 Check if the config file has been loaded. More...
bool FinishedLoadingConfig (void) const
 Check if the application has finished loading confing file (successfully or not). More...
const CNcbiRegistryGetConfig (void) const
 Get the application's cached configuration parameters. More...
CNcbiRegistryGetConfig (void)
const stringGetConfigPath (void) const
 Get the full path to the configuration file (if any) we ended up using. More...
bool ReloadConfig (CMetaRegistry::TFlags flags=CMetaRegistry::fReloadIfChanged, IRegistry::TFlags reg_flags=IRegistry::fWithNcbirc)
 Reload the configuration file. More...
SIZE_TYPE FlushDiag (CNcbiOstream *os, bool close_diag=false)
 Flush the in-memory diagnostic stream (for "eDS_ToMemory" case only). More...
const stringGetProgramDisplayName (void) const
 Get the application's "display" name. More...
const stringGetProgramExecutablePath (EFollowLinks follow_links=eIgnoreLinks) const
 Get the application's executable path. More...
CVersionInfo GetVersion (void) const
 Get the program version information. More...
const CVersionGetFullVersion (void) const
 Get the program version information. More...
bool IsDryRun (void) const
 Check if it is a test run. More...
virtual bool SetupDiag_AppSpecific (void)
 Setup application specific diagnostic stream. More...

Protected Member Functions

int Connect (const CArgs &args)
unsigned GetTimeout (const CArgs &args)
- Protected Member Functions inherited from CNcbiApplication
virtual EPreparseArgs PreparseArgs (int argc, const char *const *argv)
 Check the command line arguments before parsing them. More...
void DisableArgDescriptions (TDisableArgDesc disable=fDisableStdArgs)
void HideStdArgs (THideStdArgs hide_mask)
 Set the hide mask for the Hide Std Flags. More...
void SetStdioFlags (TStdioSetupFlags stdio_flags)
 Adjust the behavior of standard I/O streams. More...
void SetVersion (const CVersionInfo &version)
 Set the version number for the program. More...
void SetFullVersion (CRef< CVersion > version)
 Set version data for the program. More...
virtual void SetupArgDescriptions (CArgDescriptions *arg_desc)
 Setup the command line argument descriptions. More...
const CArgDescriptionsGetArgDescriptions (void) const
 Get argument descriptions (set by SetupArgDescriptions) More...
bool SetupDiag (EAppDiagStream diag)
 Setup the application diagnostic stream. More...
virtual bool LoadConfig (CNcbiRegistry &reg, const string *conf, CNcbiRegistry::TFlags reg_flags)
 Load settings from the configuration file to the registry. More...
virtual bool LoadConfig (CNcbiRegistry &reg, const string *conf)
 Load settings from the configuration file to the registry. More...
void SetProgramDisplayName (const string &app_name)
 Set program's display name. More...
virtual void AppStart (void)
 Method to be called before application start. More...
virtual void AppStop (int exit_code)
 Method to be called before application exit. More...
void SetExitCode (int exit_code, EExitMode when=eExceptionalExits)
 Force the program to return a specific exit code later, either when it exits due to an exception or unconditionally. More...

Private Attributes

auto_ptr< IConnectionm_Conn
CDBAPI_Cache m_Cache

Additional Inherited Members

- Public Types inherited from CNcbiApplication
enum  EAppNameType { eBaseName, eFullName, eRealName }
- Static Public Member Functions inherited from CNcbiApplication
static CNcbiApplicationInstance (void)
 Singleton method. More...
static SSystemMutexGetInstanceMutex (void)
 Mutex for application singleton object. More...
static string GetAppName (EAppNameType name_type=eBaseName, int argc=0, const char *const *argv=NULL)
- Protected Types inherited from CNcbiApplication
enum  EPreparseArgs { ePreparse_Continue, ePreparse_Exit }
 Result of PreparseArgs() More...
enum  EDisableArgDesc { fDisableStdArgs = 0x01 }
 Disable argument descriptions. More...
enum  EHideStdArgs {
  fHideLogfile = 0x01, fHideConffile = 0x02, fHideVersion = 0x04, fHideFullVersion = 0x08,
  fHideDryRun = 0x10, fHideHelp = 0x20, fHideFullHelp = 0x40, fHideXmlHelp = 0x80,
  fHideAll = 0xFF
 Which standard flag's descriptions should not be displayed in the usage message. More...
enum  EStdioSetup { fDefault_SyncWithStdio = 0x01, fDefault_CinBufferSize = 0x02, fBinaryCin = 0x04, fBinaryCout = 0x08 }
 Flags to adjust standard I/O streams' behaviour. More...
enum  EExitMode { eNoExits, eExceptionalExits, eAllExits }
 When to return a user-set exit code. More...
typedef int TDisableArgDesc
 Binary OR of "EDisableArgDesc". More...
typedef int THideStdArgs
 Binary OR of "EHideStdArgs". More...
typedef int TStdioSetupFlags
 Binary OR of "EStdioSetup". More...
- Static Protected Member Functions inherited from CNcbiApplication
static string FindProgramExecutablePath (int argc, const char *const *argv, string *real_path=0)
 Find the application's executable file. More...

Detailed Description

DBAPI cache administration tool.

Definition at line 53 of file dbapi_cache_admin.cpp.

Member Function Documentation

int CDBAPI_CacheAdmin::Connect ( const CArgs args)
unsigned CDBAPI_CacheAdmin::GetTimeout ( const CArgs args)

Definition at line 168 of file dbapi_cache_admin.cpp.

References min().

Referenced by Run().

void CDBAPI_CacheAdmin::Init ( void  )

Initialize the application.

The default behavior of this is "do nothing". If you have special initialization logic that needs to be peformed, then you must override this method with your own logic.

Reimplemented from CNcbiApplication.

Definition at line 70 of file dbapi_cache_admin.cpp.

References CArgDescriptions::AddDefaultKey(), CArgDescriptions::AddFlag(), eDiag_Warning, eDPF_File, eDPF_Line, CArgDescriptions::eInteger, CArgDescriptions::eString, CNcbiApplication::GetArguments(), auto_ptr< X >::release(), SetDiagPostFlag(), SetDiagPostLevel(), CNcbiApplication::SetupArgDescriptions(), and CArgDescriptions::SetUsageContext().

int CDBAPI_CacheAdmin::Run ( void  )

Run the application.

It is defined as a pure virtual method – so you must(!) supply the Run() method to implement the application-specific logic.

Exit code.

Implements CNcbiApplication.

Definition at line 183 of file dbapi_cache_admin.cpp.

References Connect(), ERR_POST_X, CNcbiApplication::GetArgs(), GetTimeout(), m_Cache, NcbiCout, NcbiEndl, and CDBAPI_Cache::Purge().

Member Data Documentation

CDBAPI_Cache CDBAPI_CacheAdmin::m_Cache

Definition at line 66 of file dbapi_cache_admin.cpp.

Referenced by Connect(), and Run().

auto_ptr<IConnection> CDBAPI_CacheAdmin::m_Conn

Definition at line 65 of file dbapi_cache_admin.cpp.

Referenced by Connect().

IDataSource* CDBAPI_CacheAdmin::m_Ds

Definition at line 64 of file dbapi_cache_admin.cpp.

The documentation for this class was generated from the following file:
Modified on Mon Oct 12 11:21:04 2015 by rev. 426318