ldas-tools-diskcacheAPI  2.7.2
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
diskCache::MountPointManager Class Reference

Manages a collection of mount points. More...

#include <MountPointManager.hh>

Inheritance diagram for diskCache::MountPointManager:
Inheritance graph
[legend]

Classes

struct  ScanResults
 Addition information regarding a scan request. More...
 
struct  UpdateResults
 Presents additional information regarding an update request. More...
 

Public Types

typedef std::list< std::string > mount_point_name_container_type
 Collection of mount point names. More...
 
typedef std::list< std::string > mount_point_name_container_type
 Collection of mount point names. More...
 
typedef std::list< std::string > mount_point_name_container_type
 Collection of mount point names. More...
 

Public Member Functions

void DirectoryCache (directory_cache_type *Cache)
 Establish the cache of directories.
 
void Find (Cache::QueryAnswer &Answer) const
 Locate files contained within the collection.
 
const mount_point_names_ro_type MountPoints () const
 Retrieve the names of the mount points.
 
Streams::IInterfaceRead (Streams::IInterface &Stream)
 Retrieve information from the stream. More...
 
void Reset (int Flag)
 Reset the requested information. More...
 
void Scan (const std::string &MountPoint, ScanResults &Results)
 Request the scanning of a single mount point. More...
 
void Update (const mount_point_name_container_type &MountPoints, UpdateResults &Results)
 Update the collection of managed mount points. More...
 
template<typename StreamT >
StreamT & Read (StreamT &Stream)
 Dump information to the stream. More...
 
template<typename OStreamT >
OStreamT & Write (OStreamT &Stream)
 Dump information to the stream. More...
 
void DirectoryCache (directory_cache_type *Cache)
 Establish the cache of directories.
 
void Find (Cache::QueryAnswer &Answer) const
 Locate files contained within the collection.
 
const mount_point_names_ro_type MountPoints () const
 Retrieve the names of the mount points.
 
Streams::IInterfaceRead (Streams::IInterface &Stream)
 Retrieve information from the stream. More...
 
void Reset (int Flag)
 Reset the requested information. More...
 
void Scan (const std::string &MountPoint, ScanResults &Results)
 Request the scanning of a single mount point. More...
 
void Update (const mount_point_name_container_type &MountPoints, UpdateResults &Results)
 Update the collection of managed mount points. More...
 
template<typename StreamT >
StreamT & Read (StreamT &Stream)
 Dump information to the stream. More...
 
template<typename OStreamT >
OStreamT & Write (OStreamT &Stream)
 Dump information to the stream. More...
 
void DirectoryCache (directory_cache_type *Cache)
 Establish the cache of directories.
 
void Find (Cache::QueryAnswer &Answer) const
 Locate files contained within the collection.
 
const mount_point_names_ro_type MountPoints () const
 Retrieve the names of the mount points.
 
Streams::IInterfaceRead (Streams::IInterface &Stream)
 Retrieve information from the stream. More...
 
void Reset (int Flag)
 Reset the requested information. More...
 
void Scan (const std::string &MountPoint, ScanResults &Results)
 Request the scanning of a single mount point. More...
 
void Update (const mount_point_name_container_type &MountPoints, UpdateResults &Results)
 Update the collection of managed mount points. More...
 
template<typename StreamT >
StreamT & Read (StreamT &Stream)
 Dump information to the stream. More...
 
template<typename OStreamT >
OStreamT & Write (OStreamT &Stream)
 Dump information to the stream. More...
 
template<>
Streams::OASCII & Write (Streams::OASCII &Stream)
 
template<>
Streams::IBinary & Read (Streams::IBinary &Stream)
 
template<>
Streams::OBinary & Write (Streams::OBinary &Stream)
 

Static Public Attributes

static const int RESET_CACHE = 0x0001
 Reset the cached information.
 
static const int RESET_MANAGED_DIRECTORIES = 0x0002
 Reset the lists of managed directories.
 

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

◆ mount_point_name_container_type [1/3]

Collection of mount point names.

This is used to ease the management of the collection of mount points when only the name is significant. This container does not impose any particular order.

◆ mount_point_name_container_type [2/3]

Collection of mount point names.

This is used to ease the management of the collection of mount points when only the name is significant. This container does not impose any particular order.

◆ mount_point_name_container_type [3/3]

Collection of mount point names.

This is used to ease the management of the collection of mount points when only the name is significant. This container does not impose any particular order.

Member Function Documentation

◆ Read() [1/7]

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

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

◆ Read() [2/7]

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

Retrieve information from the stream.

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

◆ Read() [3/7]

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

Retrieve information from the stream.

Parameters
[in]StreamSource of the new information.

◆ Read() [4/7]

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

Retrieve information from the stream.

Parameters
[in]StreamSource of the new information.

◆ Read() [5/7]

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

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Read() [6/7]

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

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Read() [7/7]

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

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Reset() [1/3]

void diskCache::MountPointManager::Reset ( int  Flag)

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]

void diskCache::MountPointManager::Reset ( int  Flag)

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]

void diskCache::MountPointManager::Reset ( int  Flag)

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::MountPointManager::Scan ( const std::string &  MountPoint,
ScanResults Results 
)

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]

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

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]

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

Request the scanning of a single mount point.

This does a deep scan of the requested mount point.

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

◆ Update() [1/3]

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

Update the collection of managed mount points.

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

◆ Update() [2/3]

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

Update the collection of managed mount points.

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

◆ Update() [3/3]

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

Update the collection of managed mount points.

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

◆ Write() [1/5]

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

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

◆ Write() [2/5]

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

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

◆ Write() [3/5]

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

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Write() [4/5]

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

Dump information to the stream.

Parameters
[in]StreamSink for the information.

◆ Write() [5/5]

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

Dump information to the stream.

Parameters
[in]StreamSink for the information.

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