xapian-core  1.4.20
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
BackendManagerRemote Class Reference

BackendManager subclass for remote databases. More...

#include <backendmanager_remote.h>

+ Inheritance diagram for BackendManagerRemote:
+ Collaboration diagram for BackendManagerRemote:

Public Member Functions

 BackendManagerRemote (BackendManager *sub_manager_)
 
std::string get_writable_database_args (const std::string &name, const std::string &file)
 Get the args for opening a remote database indexing a single file. More...
 
std::string get_writable_database_args (const std::string &path, unsigned int timeout)
 Get the args for opening a writable remote database with the specified timeout. More...
 
std::string get_remote_database_args (const std::vector< std::string > &files, unsigned int timeout)
 Get the args for opening a remote database with the specified timeout. More...
 
std::string get_remote_database_args (const std::string &name, unsigned int timeout)
 Get the args for opening a remote database with the specified timeout. More...
 
std::string get_writable_database_as_database_args ()
 Get the args for opening the last opened WritableDatabase. More...
 
std::string get_writable_database_again_args ()
 Get the args for opening the last opened WritableDatabase again. More...
 
std::string get_generated_database_path (const std::string &name)
 Get generated database path from sub_manager. More...
 
Xapian::WritableDatabase get_generated_database (const std::string &name)
 Get generated database. More...
 
- Public Member Functions inherited from BackendManager
 BackendManager (const std::string &datadir_)
 Constructor. More...
 
virtual ~BackendManager ()
 We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor. More...
 
virtual std::string get_dbtype () const
 Get the database type currently in use. More...
 
const std::string & get_datadir () const
 Get the directory to store data in. More...
 
Xapian::Database get_database (const std::vector< std::string > &files)
 Get a database instance of the current type. More...
 
Xapian::Database get_database (const std::string &file)
 Get a database instance of the current type, single file case. More...
 
Xapian::Database get_database (const std::string &dbname, void(*gen)(Xapian::WritableDatabase &, const std::string &), const std::string &arg)
 Get a database instance of the current type, generated case. More...
 
virtual Xapian::Database get_database_by_path (const std::string &path)
 Get a database instance by path. More...
 
std::string get_database_path (const std::vector< std::string > &files)
 Get the path of a database instance, if such a thing exists. More...
 
std::string get_database_path (const std::string &file)
 Get the path of a database instance, if such a thing exists (single file case). More...
 
std::string get_database_path (const std::string &dbname, void(*gen)(Xapian::WritableDatabase &, const std::string &), const std::string &arg)
 Get the path of a generated database instance. More...
 
virtual Xapian::WritableDatabase get_writable_database (const std::string &name, const std::string &file)
 Get a writable database instance. More...
 
virtual Xapian::WritableDatabase get_remote_writable_database (std::string args)
 Get a remote Xapian::WritableDatabase instance with specified args. More...
 
virtual std::string get_writable_database_path (const std::string &name)
 Get the path of a writable database instance, if such a thing exists. More...
 
virtual void finalise_generated_database (const std::string &name)
 Finalise the generated database. More...
 
virtual Xapian::Database get_remote_database (const std::vector< std::string > &files, unsigned int timeout)
 Get a remote database instance with the specified timeout. More...
 
virtual Xapian::Database get_writable_database_as_database ()
 Create a Database object for the last opened WritableDatabase. More...
 
virtual Xapian::WritableDatabase get_writable_database_again ()
 Create a WritableDatabase object for the last opened WritableDatabase. More...
 
virtual std::string get_writable_database_path_again ()
 Get the path of the last opened WritableDatabase. More...
 
virtual std::string get_compaction_output_path (const std::string &name)
 Get a path to compact a database to. More...
 
virtual void clean_up ()
 Called after each test, to perform any necessary cleanup. More...
 

Protected Attributes

BackendManagersub_manager
 

Private Member Functions

void operator= (const BackendManagerRemote &)
 Don't allow assignment. More...
 
 BackendManagerRemote (const BackendManagerRemote &)
 Don't allow copying. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BackendManager
static const char * get_xapian_progsrv_command ()
 Get the command line required to run xapian-progsrv. More...
 
- Protected Member Functions inherited from BackendManager
void index_files_to_database (Xapian::WritableDatabase &database, const std::vector< std::string > &files)
 Index data from zero or more text files into a database. More...
 
bool create_dir_if_needed (const std::string &dirname)
 Create the directory dirname if needed. More...
 
virtual Xapian::Database do_get_database (const std::vector< std::string > &files)
 Virtual method implementing get_database(). More...
 
virtual std::string do_get_database_path (const std::vector< std::string > &files)
 Virtual method implementing get_database_path(). More...
 

Detailed Description

BackendManager subclass for remote databases.

Definition at line 31 of file backendmanager_remote.h.

Constructor & Destructor Documentation

◆ BackendManagerRemote() [1/2]

BackendManagerRemote::BackendManagerRemote ( const BackendManagerRemote )
private

Don't allow copying.

◆ BackendManagerRemote() [2/2]

BackendManagerRemote::BackendManagerRemote ( BackendManager sub_manager_)
inlineexplicit

Member Function Documentation

◆ get_generated_database()

Xapian::WritableDatabase BackendManagerRemote::get_generated_database ( const std::string &  name)
virtual

Get generated database.

Reimplemented from BackendManager.

Definition at line 36 of file backendmanager_remote.cc.

References BackendManager::get_writable_database(), and sub_manager.

Referenced by BackendManagerRemote().

◆ get_generated_database_path()

std::string BackendManagerRemote::get_generated_database_path ( const std::string &  name)
virtual

Get generated database path from sub_manager.

Reimplemented from BackendManager.

Definition at line 31 of file backendmanager_remote.cc.

References BackendManager::get_writable_database_path(), and sub_manager.

Referenced by BackendManagerRemote().

◆ get_remote_database_args() [1/2]

std::string BackendManagerRemote::get_remote_database_args ( const std::vector< std::string > &  files,
unsigned int  timeout 
)

Get the args for opening a remote database with the specified timeout.

Definition at line 67 of file backendmanager_remote.cc.

References BackendManager::get_database_path(), Xapian::Internal::str(), and sub_manager.

Referenced by BackendManagerRemote().

◆ get_remote_database_args() [2/2]

std::string BackendManagerRemote::get_remote_database_args ( const std::string &  name,
unsigned int  timeout 
)

Get the args for opening a remote database with the specified timeout.

Definition at line 78 of file backendmanager_remote.cc.

References Xapian::Internal::str().

◆ get_writable_database_again_args()

std::string BackendManagerRemote::get_writable_database_again_args ( )

Get the args for opening the last opened WritableDatabase again.

Definition at line 97 of file backendmanager_remote.cc.

References BackendManager::get_writable_database_path_again(), and sub_manager.

Referenced by BackendManagerRemote().

◆ get_writable_database_args() [1/2]

std::string BackendManagerRemote::get_writable_database_args ( const std::string &  name,
const std::string &  file 
)

Get the args for opening a remote database indexing a single file.

Definition at line 42 of file backendmanager_remote.cc.

References BackendManager::get_writable_database(), BackendManager::get_writable_database_path(), and sub_manager.

Referenced by BackendManagerRemote().

◆ get_writable_database_args() [2/2]

std::string BackendManagerRemote::get_writable_database_args ( const std::string &  path,
unsigned int  timeout 
)
virtual

Get the args for opening a writable remote database with the specified timeout.

Reimplemented from BackendManager.

Definition at line 56 of file backendmanager_remote.cc.

References Xapian::Internal::str().

◆ get_writable_database_as_database_args()

std::string BackendManagerRemote::get_writable_database_as_database_args ( )

Get the args for opening the last opened WritableDatabase.

Definition at line 89 of file backendmanager_remote.cc.

References BackendManager::get_writable_database_path_again(), and sub_manager.

Referenced by BackendManagerRemote().

◆ operator=()

void BackendManagerRemote::operator= ( const BackendManagerRemote )
private

Don't allow assignment.

Member Data Documentation

◆ sub_manager

BackendManager* BackendManagerRemote::sub_manager
protected

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