ldas-tools  2.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Static Public Member Functions | List of all members
GenericAPI::MountPointStatus Class Reference

Monitors a list of directories. More...

#include <MountPointStatus.hh>

Public Types

enum  state_type { STATE_OFFLINE, STATE_ONLINE }
 
typedef std::list< std::string > mount_point_list_type
 Container for a set of mount points. More...
 

Static Public Member Functions

static bool Initialize ()
 Initialize the class. More...
 
static void Add (const mount_point_list_type &MountPoint)
 Adds directories to set of managed directories. More...
 
static bool IsDirManaged (const std::string &Dir)
 Checks if directory is being managed. More...
 
static void Remove (const mount_point_list_type &MountPoint)
 Removes directories from the set of managed directories. More...
 
static void Set (const mount_point_list_type &MountPoint)
 Resets the set of directories to be managed. More...
 
static void Set (const std::vector< std::string > &MountPoint)
 Resets the set of directories to be managed. More...
 
static state_type Status (const std::string &Path)
 Returns the on-line status of the file system. More...
 
static void Offline (const std::string &Path)
 

Detailed Description

Monitors a list of directories.

The main focus of this class is to provide methods which maintain information about a group of directories.

Member Typedef Documentation

typedef std::list< std::string > GenericAPI::MountPointStatus::mount_point_list_type

Container for a set of mount points.

This type is used by several routines to pass a set of directories on which to operate.

Member Enumeration Documentation

Enumerator
STATE_OFFLINE 
STATE_ONLINE 

Member Function Documentation

static void GenericAPI::MountPointStatus::Add ( const mount_point_list_type MountPoint)
static

Adds directories to set of managed directories.

Parameters
[in]MountPointA group of directories to be added.
Returns
Nothing
static bool GenericAPI::MountPointStatus::Initialize ( )
static

Initialize the class.

Returns
True if initialization completes successfully, false otherwise.
static bool GenericAPI::MountPointStatus::IsDirManaged ( const std::string &  Dir)
static

Checks if directory is being managed.

Parameters
[in]DirThe name of a file or directory on the file system
Returns
If their is an exact match, then true is returned, false otherwise.
static void GenericAPI::MountPointStatus::Offline ( const std::string &  Path)
static
static void GenericAPI::MountPointStatus::Remove ( const mount_point_list_type MountPoint)
static

Removes directories from the set of managed directories.

Parameters
[in]MountPointA group of directories to be removed.
Returns
Nothing
static void GenericAPI::MountPointStatus::Set ( const mount_point_list_type MountPoint)
static

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing
void GenericAPI::MountPointStatus::Set ( const std::vector< std::string > &  MountPoint)
inlinestatic

Resets the set of directories to be managed.

Parameters
[in]MountPointA group of directories to be managed.
Returns
Nothing
static state_type GenericAPI::MountPointStatus::Status ( const std::string &  Path)
static

Returns the on-line status of the file system.

Parameters
[in]PathThe Path to a file or directory on the file system for which the on-line status is being queried.
Returns
The on-line status of the file system.

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