SDGTx caching scheme.
More...
#include <SDGTx.hh>
|
virtual bool | Configure (const std::string &Variable, const std::string &Value) |
| Allow for customization. More...
|
|
virtual bool | Configure (const std::string &Variable, const std::string &Value) |
| Allow for customization. More...
|
|
virtual bool | Configure (const std::string &Variable, const std::string &Value) |
| Allow for customization. More...
|
|
|
static RegistrySingleton::id_type | RegisterSearchEngine () |
| Register as a search engine. More...
|
|
static void | Find (const Streams::Streamable &Source, const Directory &Dir, QueryAnswer &Answer) |
|
static bool | IsMatch (DirectoryScanData &Data) |
| Function called during processing of a directory. More...
|
|
static void | OnDirectoryClose (DirectoryScanData &Data) |
| Function called after all files have been processed. More...
|
|
static void | Query (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer) |
| Query for specific data. More...
|
|
static RegistrySingleton::id_type | RegisterSearchEngine () |
| Register as a search engine.
|
|
static bool | IsMatch (DirectoryScanData &Data) |
| Function called during processing of a directory. More...
|
|
static void | OnDirectoryClose (DirectoryScanData &Data) |
| Function called after all files have been processed. More...
|
|
static void | Query (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer) |
| Query for specific data. More...
|
|
static RegistrySingleton::id_type | RegisterSearchEngine () |
| Register as a search engine.
|
|
static bool | IsMatch (DirectoryScanData &Data) |
| Function called during processing of a directory. More...
|
|
static void | OnDirectoryClose (DirectoryScanData &Data) |
| Function called after all files have been processed. More...
|
|
static void | Query (const Cache::QueryParams &Params, Cache::QueryAnswer &Answer) |
| Query for specific data. More...
|
|
SDGTx caching scheme.
This caching scheme is based on the S-D-G-T.%<ext%> naming convention that is referenced in the appendix of the Frame Specification.
◆ Configure() [1/3]
bool diskCache::Cache::SDGTx::Configure |
( |
const std::string & |
Variable, |
|
|
const std::string & |
Value |
|
) |
| |
|
virtual |
Allow for customization.
- Parameters
-
[in] | Variable | Name of the option to modify |
[in] | Value | The ascii string representation of the value for the option. |
- Returns
- Upon successful setting of the option, true is returned; false otherwise.
Implements diskCache::Cache::Interface.
◆ Configure() [2/3]
virtual bool diskCache::Cache::SDGTx::Configure |
( |
const std::string & |
Variable, |
|
|
const std::string & |
Value |
|
) |
| |
|
virtual |
Allow for customization.
- Parameters
-
[in] | Variable | Name of the option to modify |
[in] | Value | The ascii string representation of the value for the option. |
- Returns
- Upon successful setting of the option, true is returned; false otherwise.
Implements diskCache::Cache::Interface.
◆ Configure() [3/3]
virtual bool diskCache::Cache::SDGTx::Configure |
( |
const std::string & |
Variable, |
|
|
const std::string & |
Value |
|
) |
| |
|
virtual |
Allow for customization.
- Parameters
-
[in] | Variable | Name of the option to modify |
[in] | Value | The ascii string representation of the value for the option. |
- Returns
- Upon successful setting of the option, true is returned; false otherwise.
Implements diskCache::Cache::Interface.
◆ Find()
- Todo:
- Need to catch appropriate exceptions
◆ IsMatch() [1/3]
bool diskCache::Cache::SDGTx::IsMatch |
( |
DirectoryScanData & |
Data | ) |
|
|
static |
Function called during processing of a directory.
- Parameters
-
[in] | Data | Place to log information as the directory is being processed. |
- Returns
- The value true is returned if the file being processed is cached by the indexing algorithm; false otherwise.
◆ IsMatch() [2/3]
static bool diskCache::Cache::SDGTx::IsMatch |
( |
DirectoryScanData & |
Data | ) |
|
|
static |
Function called during processing of a directory.
- Parameters
-
[in] | Data | Place to log information as the directory is being processed. |
- Returns
- The value true is returned if the file being processed is cached by the indexing algorithm; false otherwise.
◆ IsMatch() [3/3]
static bool diskCache::Cache::SDGTx::IsMatch |
( |
DirectoryScanData & |
Data | ) |
|
|
static |
Function called during processing of a directory.
- Parameters
-
[in] | Data | Place to log information as the directory is being processed. |
- Returns
- The value true is returned if the file being processed is cached by the indexing algorithm; false otherwise.
◆ OnDirectoryClose() [1/3]
void diskCache::Cache::SDGTx::OnDirectoryClose |
( |
DirectoryScanData & |
Data | ) |
|
|
static |
Function called after all files have been processed.
- Parameters
-
[in] | Data | Information gathered during teh scanning of the directory. |
When finished reading from the directory, all files that have been identified as new need to go under further scrutinization to ensure they do not violate any of the rules.
- Todo:
- Need to look at the old data to see if files existed in the previous version since they will need to be removed here.
- Todo:
- Need to flag this data as overlapping with other data within this directory
- Todo:
- Verify that file is unique under the mount point
◆ OnDirectoryClose() [2/3]
static void diskCache::Cache::SDGTx::OnDirectoryClose |
( |
DirectoryScanData & |
Data | ) |
|
|
static |
Function called after all files have been processed.
- Parameters
-
[in] | Data | Information gathered during teh scanning of the directory. |
◆ OnDirectoryClose() [3/3]
static void diskCache::Cache::SDGTx::OnDirectoryClose |
( |
DirectoryScanData & |
Data | ) |
|
|
static |
Function called after all files have been processed.
- Parameters
-
[in] | Data | Information gathered during teh scanning of the directory. |
◆ Query() [1/3]
static void diskCache::Cache::SDGTx::Query |
( |
const Cache::QueryParams & |
Params, |
|
|
Cache::QueryAnswer & |
Answer |
|
) |
| |
|
static |
Query for specific data.
- Parameters
-
[in] | Params | The ASCII representation of the query. |
[out] | Answer | The answer set. |
◆ Query() [2/3]
static void diskCache::Cache::SDGTx::Query |
( |
const Cache::QueryParams & |
Params, |
|
|
Cache::QueryAnswer & |
Answer |
|
) |
| |
|
static |
Query for specific data.
- Parameters
-
[in] | Params | The ASCII representation of the query. |
[out] | Answer | The answer set. |
◆ Query() [3/3]
static void diskCache::Cache::SDGTx::Query |
( |
const Cache::QueryParams & |
Params, |
|
|
Cache::QueryAnswer & |
Answer |
|
) |
| |
|
static |
Query for specific data.
- Parameters
-
[in] | Params | The ASCII representation of the query. |
[out] | Answer | The answer set. |
◆ RegisterSearchEngine()
RegistrySingleton::id_type diskCache::Cache::SDGTx::RegisterSearchEngine |
( |
| ) |
|
|
static |
Register as a search engine.
Register the search engine so it can be used throughout the system.
The documentation for this class was generated from the following files:
- /build/ldas-tools-diskcacheapi-2.7.2/debian/tmp/usr/include/diskcacheAPI/Cache/SDGTx.hh
- /build/ldas-tools-diskcacheapi-2.7.2/src/Cache/SDGTx.cc