ldas-tools-diskcacheAPI  2.7.1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
diskCache::MountPointManagerSingleton Class Reference

Manages a collection of mount points. More...

#include <MountPointManagerSingleton.hh>

Inheritance diagram for diskCache::MountPointManagerSingleton:
Inheritance graph
[legend]
Collaboration diagram for diskCache::MountPointManagerSingleton:
Collaboration graph
[legend]

Public Types

typedef MountPointManager::mount_point_name_container_type mount_point_name_container_type
 
typedef MountPointManager::UpdateResults UpdateResults
 
typedef MountPointManager::ScanResults ScanResults
 
typedef MountPointManager::mount_point_names_ro_type mount_point_names_ro_type
 
typedef MountPointManager::mount_point_name_container_type mount_point_name_container_type
 
typedef MountPointManager::UpdateResults UpdateResults
 
typedef MountPointManager::ScanResults ScanResults
 
typedef MountPointManager::mount_point_names_ro_type mount_point_names_ro_type
 
typedef MountPointManager::mount_point_name_container_type mount_point_name_container_type
 
typedef MountPointManager::UpdateResults UpdateResults
 
typedef MountPointManager::ScanResults ScanResults
 
typedef MountPointManager::mount_point_names_ro_type mount_point_names_ro_type
 

Public Member Functions

 DECLARE_READ_WRITE_SINGLETON (MountPointManagerSingleton)
 
 DECLARE_READ_WRITE_SINGLETON (MountPointManagerSingleton)
 
 DECLARE_READ_WRITE_SINGLETON (MountPointManagerSingleton)
 

Static Public Member Functions

static void Find (Cache::QueryAnswer &Answer)
 Locate files contained within the collection. More...
 
static const mount_point_names_ro_type MountPoints ()
 Retrieve list of registered mount points. More...
 
static void Reset (int Flag)
 Reset the requested information. More...
 
static void Scan (const std::string &MountPoint, ScanResults &Results)
 Request the scanning of a single mount point. More...
 
static void Update (const mount_point_name_container_type &MountPoints, UpdateResults &Results)
 Update the collection of managed mount points. More...
 
template<typename StreamT >
static StreamT & Read (StreamT &Stream)
 Dump information to the stream. More...
 
template<typename StreamT >
static StreamT & Write (StreamT &Stream)
 Dump information to the stream. More...
 
static void Find (Cache::QueryAnswer &Answer)
 Locate files contained within the collection. More...
 
static const mount_point_names_ro_type MountPoints ()
 Retrieve list of registered mount points. More...
 
static void Reset (int Flag)
 Reset the requested information. More...
 
static void Scan (const std::string &MountPoint, ScanResults &Results)
 Request the scanning of a single mount point. More...
 
static void Update (const mount_point_name_container_type &MountPoints, UpdateResults &Results)
 Update the collection of managed mount points. More...
 
template<typename StreamT >
static StreamT & Read (StreamT &Stream)
 Dump information to the stream. More...
 
template<typename StreamT >
static StreamT & Write (StreamT &Stream)
 Dump information to the stream. More...
 
static void Find (Cache::QueryAnswer &Answer)
 Locate files contained within the collection. More...
 
static const mount_point_names_ro_type MountPoints ()
 Retrieve list of registered mount points. More...
 
static void Reset (int Flag)
 Reset the requested information. More...
 
static void Scan (const std::string &MountPoint, ScanResults &Results)
 Request the scanning of a single mount point. More...
 
static void Update (const mount_point_name_container_type &MountPoints, UpdateResults &Results)
 Update the collection of managed mount points. More...
 
template<typename StreamT >
static StreamT & Read (StreamT &Stream)
 Dump information to the stream. More...
 
template<typename StreamT >
static StreamT & Write (StreamT &Stream)
 Dump information to the stream. More...
 

Static Public Attributes

static const int RESET_CACHE
 Reset the cached information. More...
 
static const int RESET_MANAGED_DIRECTORIES
 Reset the lists of managed directories. More...
 
static const int RESET_CACHE
 Reset the cached information. More...
 
static const int RESET_MANAGED_DIRECTORIES
 Reset the lists of managed directories. More...
 
static const int RESET_CACHE
 Reset the cached information. More...
 
static const int RESET_MANAGED_DIRECTORIES
 Reset the lists of managed directories. More...
 

Private Types

typedef Cache::DirectoryManager directory_cache_type
 
typedef Cache::DirectoryManager directory_cache_type
 
typedef Cache::DirectoryManager directory_cache_type
 
typedef LDASTools::AL::ReadWriteLockVariable< LDASTools::AL::ReadWriteLock::WRITE, mount_point_name_container_typemount_point_names_rw_type
 
typedef LDASTools::AL::ReadWriteLockVariable< LDASTools::AL::ReadWriteLock::WRITE, mount_point_name_container_typemount_point_names_rw_type
 
typedef LDASTools::AL::ReadWriteLockVariable< LDASTools::AL::ReadWriteLock::WRITE, mount_point_name_container_typemount_point_names_rw_type
 
typedef std::set< std::string > excluded_mount_point_names_type
 
typedef std::set< std::string > excluded_mount_point_names_type
 
typedef std::set< std::string > excluded_mount_point_names_type
 

Private Member Functions

void DirectoryCache (directory_cache_type *Cache)
 Establish the cache of directories. More...
 
void DirectoryCache (directory_cache_type *Cache)
 Establish the cache of directories. More...
 
void DirectoryCache (directory_cache_type *Cache)
 Establish the cache of directories. More...
 
void Find (Cache::QueryAnswer &Answer) const
 Locate files contained within the collection. More...
 
const mount_point_names_ro_type MountPoints () const
 Retrieve the names of the mount points. More...
 
Streams::IInterfaceRead (Streams::IInterface &Stream)
 Retrieve information from the stream. More...
 
template<>
Streams::IBinaryRead (Streams::IBinary &Stream)
 
template<typename OStreamT >
OStreamT & Write (OStreamT &Stream)
 Dump information to the stream. More...
 
template<>
Streams::OASCIIWrite (Streams::OASCII &Stream)
 
template<>
Streams::OBinaryWrite (Streams::OBinary &Stream)
 
const mount_point_names_ro_type mount_point_names_ro () const
 
const mount_point_names_ro_type mount_point_names_ro () const
 
const mount_point_names_ro_type mount_point_names_ro () const
 
mount_point_names_rw_type mount_point_names_rw ()
 
mount_point_names_rw_type mount_point_names_rw ()
 
mount_point_names_rw_type mount_point_names_rw ()
 

Private Attributes

mount_point_name_container_type m_mount_points_dictionary_order
 
mount_point_name_container_type p_mount_points_search_order
 
excluded_mount_point_names_type excluded_mount_point_names
 
mount_point_names_rw_type::baton_type p_mount_points_search_order_baton
 
directory_cache_typem_directory_cache
 

Detailed Description

Manages a collection of mount points.

A collection of mount points is managed by this singleton class. Each mount point represents a starting point for data searches. The collection of mount points is order sensative in that directories that appear higher in the list will be prioritised when searching for data.

Member Typedef Documentation

◆ directory_cache_type [1/3]

◆ directory_cache_type [2/3]

◆ directory_cache_type [3/3]

◆ excluded_mount_point_names_type [1/3]

◆ excluded_mount_point_names_type [2/3]

◆ excluded_mount_point_names_type [3/3]

◆ mount_point_name_container_type [1/3]

◆ mount_point_name_container_type [2/3]

◆ mount_point_name_container_type [3/3]

◆ mount_point_names_ro_type [1/3]

◆ mount_point_names_ro_type [2/3]

◆ mount_point_names_ro_type [3/3]

◆ mount_point_names_rw_type [1/3]

typedef LDASTools::AL::ReadWriteLockVariable< LDASTools::AL::ReadWriteLock::WRITE, mount_point_name_container_type > diskCache::MountPointManager::mount_point_names_rw_type
privateinherited

◆ mount_point_names_rw_type [2/3]

typedef LDASTools::AL::ReadWriteLockVariable< LDASTools::AL::ReadWriteLock::WRITE, mount_point_name_container_type > diskCache::MountPointManager::mount_point_names_rw_type
privateinherited

◆ mount_point_names_rw_type [3/3]

typedef LDASTools::AL::ReadWriteLockVariable< LDASTools::AL::ReadWriteLock::WRITE, mount_point_name_container_type > diskCache::MountPointManager::mount_point_names_rw_type
privateinherited

◆ ScanResults [1/3]

◆ ScanResults [2/3]

◆ ScanResults [3/3]

◆ UpdateResults [1/3]

◆ UpdateResults [2/3]

◆ UpdateResults [3/3]

Member Function Documentation

◆ DECLARE_READ_WRITE_SINGLETON() [1/3]

diskCache::MountPointManagerSingleton::DECLARE_READ_WRITE_SINGLETON ( MountPointManagerSingleton  )

◆ DECLARE_READ_WRITE_SINGLETON() [2/3]

diskCache::MountPointManagerSingleton::DECLARE_READ_WRITE_SINGLETON ( MountPointManagerSingleton  )

◆ DECLARE_READ_WRITE_SINGLETON() [3/3]

diskCache::MountPointManagerSingleton::DECLARE_READ_WRITE_SINGLETON ( MountPointManagerSingleton  )

◆ DirectoryCache() [1/3]

void diskCache::MountPointManager::DirectoryCache ( directory_cache_type Cache)
inlineinherited

Establish the cache of directories.

◆ DirectoryCache() [2/3]

void diskCache::MountPointManager::DirectoryCache ( directory_cache_type Cache)
inherited

Establish the cache of directories.

◆ DirectoryCache() [3/3]

void diskCache::MountPointManager::DirectoryCache ( directory_cache_type Cache)
inherited

Establish the cache of directories.

◆ Find() [1/4]

void diskCache::MountPointManagerSingleton::Find ( Cache::QueryAnswer Answer)
inlinestatic

Locate files contained within the collection.

◆ Find() [2/4]

static void diskCache::MountPointManagerSingleton::Find ( Cache::QueryAnswer Answer)
static

Locate files contained within the collection.

◆ Find() [3/4]

static void diskCache::MountPointManagerSingleton::Find ( Cache::QueryAnswer Answer)
static

Locate files contained within the collection.

◆ Find() [4/4]

void diskCache::MountPointManager::Find ( Cache::QueryAnswer Answer) const
inherited

Locate files contained within the collection.

◆ mount_point_names_ro() [1/3]

const MountPointManager::mount_point_names_ro_type diskCache::MountPointManager::mount_point_names_ro ( ) const
inlineprivateinherited

◆ mount_point_names_ro() [2/3]

const mount_point_names_ro_type diskCache::MountPointManager::mount_point_names_ro ( ) const
privateinherited

◆ mount_point_names_ro() [3/3]

const mount_point_names_ro_type diskCache::MountPointManager::mount_point_names_ro ( ) const
privateinherited

◆ mount_point_names_rw() [1/3]

MountPointManager::mount_point_names_rw_type diskCache::MountPointManager::mount_point_names_rw ( )
inlineprivateinherited

◆ mount_point_names_rw() [2/3]

mount_point_names_rw_type diskCache::MountPointManager::mount_point_names_rw ( )
privateinherited

◆ mount_point_names_rw() [3/3]

mount_point_names_rw_type diskCache::MountPointManager::mount_point_names_rw ( )
privateinherited

◆ MountPoints() [1/4]

const MountPointManagerSingleton::mount_point_names_ro_type diskCache::MountPointManagerSingleton::MountPoints ( )
inlinestatic

Retrieve list of registered mount points.

◆ MountPoints() [2/4]

static const mount_point_names_ro_type diskCache::MountPointManagerSingleton::MountPoints ( )
static

Retrieve list of registered mount points.

◆ MountPoints() [3/4]

static const mount_point_names_ro_type diskCache::MountPointManagerSingleton::MountPoints ( )
static

Retrieve list of registered mount points.

◆ MountPoints() [4/4]

const MountPointManager::mount_point_names_ro_type diskCache::MountPointManager::MountPoints ( ) const
inlineinherited

Retrieve the names of the mount points.

◆ Read() [1/5]

template<>
Streams::IBinary& diskCache::MountPointManager::Read ( Streams::IBinary Stream)
inherited

Handles writing of a single collection of mount points to a binary stream.

◆ Read() [2/5]

Streams::IInterface & diskCache::MountPointManager::Read ( Streams::IInterface Stream)
inherited

Retrieve information from the stream.

Parameters
[in]StreamSource of the new information.
Todo:
Place into the mount point list

◆ Read() [3/5]

template<typename StreamT >
StreamT & diskCache::MountPointManagerSingleton::Read ( StreamT &  Stream)
inlinestatic

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Read() [4/5]

template<typename StreamT >
static StreamT& diskCache::MountPointManagerSingleton::Read ( StreamT &  Stream)
static

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Read() [5/5]

template<typename StreamT >
static StreamT& diskCache::MountPointManagerSingleton::Read ( StreamT &  Stream)
static

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Reset() [1/3]

void diskCache::MountPointManagerSingleton::Reset ( int  Flag)
inlinestatic

Reset the requested information.

This allows for the purging of certain information so as to force a refreshing of the information.

Parameters
[in]FlagThis is an ORed flag indicating what should be cleaned

◆ Reset() [2/3]

static void diskCache::MountPointManagerSingleton::Reset ( int  Flag)
static

Reset the requested information.

This allows for the purging of certain information so as to force a refreshing of the information.

Parameters
[in]FlagThis is an ORed flag indicating what should be cleaned

◆ Reset() [3/3]

static void diskCache::MountPointManagerSingleton::Reset ( int  Flag)
static

Reset the requested information.

This allows for the purging of certain information so as to force a refreshing of the information.

Parameters
[in]FlagThis is an ORed flag indicating what should be cleaned

◆ Scan() [1/3]

void diskCache::MountPointManagerSingleton::Scan ( const std::string &  MountPoint,
ScanResults Results 
)
inlinestatic

Request the scanning of a single mount point.

Parameters
[in]MountPointThe name of the mount point to scan.
[out]ResultsInformation gathered during the scan.

◆ Scan() [2/3]

static void diskCache::MountPointManagerSingleton::Scan ( const std::string &  MountPoint,
ScanResults Results 
)
static

Request the scanning of a single mount point.

Parameters
[in]MountPointThe name of the mount point to scan.
[out]ResultsInformation gathered during the scan.

◆ Scan() [3/3]

static void diskCache::MountPointManagerSingleton::Scan ( const std::string &  MountPoint,
ScanResults Results 
)
static

Request the scanning of a single mount point.

Parameters
[in]MountPointThe name of the mount point to scan.
[out]ResultsInformation gathered during the scan.

◆ Update() [1/3]

void diskCache::MountPointManagerSingleton::Update ( const mount_point_name_container_type MountPoints,
UpdateResults Results 
)
inlinestatic

Update the collection of managed mount points.

Parameters
[in]MountPointsOrdered collection of mount points to be managed.
[out]ResultsResults.

◆ Update() [2/3]

static void diskCache::MountPointManagerSingleton::Update ( const mount_point_name_container_type MountPoints,
UpdateResults Results 
)
static

Update the collection of managed mount points.

Parameters
[in]MountPointsOrdered collection of mount points to be managed.
[out]ResultsResults.

◆ Update() [3/3]

static void diskCache::MountPointManagerSingleton::Update ( const mount_point_name_container_type MountPoints,
UpdateResults Results 
)
static

Update the collection of managed mount points.

Parameters
[in]MountPointsOrdered collection of mount points to be managed.
[out]ResultsResults.

◆ Write() [1/6]

template<typename OStreamT >
OStreamT& diskCache::MountPointManager::Write ( OStreamT &  Stream)
inherited

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Write() [2/6]

template<>
Streams::OASCII& diskCache::MountPointManager::Write ( Streams::OASCII Stream)
inherited

Handles writing of a single collection of mount points to a binary stream.

◆ Write() [3/6]

template<>
Streams::OBinary& diskCache::MountPointManager::Write ( Streams::OBinary Stream)
inherited

Handles writing of a single collection of mount points to a binary stream.

◆ Write() [4/6]

template<typename StreamT >
StreamT & diskCache::MountPointManagerSingleton::Write ( StreamT &  Stream)
inlinestatic

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Write() [5/6]

template<typename StreamT >
static StreamT& diskCache::MountPointManagerSingleton::Write ( StreamT &  Stream)
static

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Write() [6/6]

template<typename StreamT >
static StreamT& diskCache::MountPointManagerSingleton::Write ( StreamT &  Stream)
static

Dump information to the stream.

Parameters
[in]StreamSink for the information.

Member Data Documentation

◆ excluded_mount_point_names

excluded_mount_point_names_type diskCache::MountPointManager::excluded_mount_point_names
privateinherited

◆ m_directory_cache

directory_cache_type * diskCache::MountPointManager::m_directory_cache
privateinherited

◆ m_mount_points_dictionary_order

mount_point_name_container_type diskCache::MountPointManager::m_mount_points_dictionary_order
privateinherited

◆ p_mount_points_search_order

mount_point_name_container_type diskCache::MountPointManager::p_mount_points_search_order
privateinherited

◆ p_mount_points_search_order_baton

mount_point_names_rw_type::baton_type diskCache::MountPointManager::p_mount_points_search_order_baton
mutableprivateinherited

◆ RESET_CACHE [1/3]

static const int diskCache::MountPointManager::RESET_CACHE
static

Reset the cached information.

◆ RESET_CACHE [2/3]

static const int diskCache::MountPointManager::RESET_CACHE
static

Reset the cached information.

◆ RESET_CACHE [3/3]

static const int diskCache::MountPointManager::RESET_CACHE
static

Reset the cached information.

◆ RESET_MANAGED_DIRECTORIES [1/3]

static const int diskCache::MountPointManager::RESET_MANAGED_DIRECTORIES
static

Reset the lists of managed directories.

◆ RESET_MANAGED_DIRECTORIES [2/3]

static const int diskCache::MountPointManager::RESET_MANAGED_DIRECTORIES
static

Reset the lists of managed directories.

◆ RESET_MANAGED_DIRECTORIES [3/3]

static const int diskCache::MountPointManager::RESET_MANAGED_DIRECTORIES
static

Reset the lists of managed directories.


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