ldas-tools-ldasgen  2.7.2
Namespaces | Classes | Typedefs | Functions | Variables
GenericAPI Namespace Reference

Namespaces

 Log
 
 Net
 
 Status
 
 Symbols
 
 TCL
 

Classes

class  ChannelNameLexer
 Supports parsing of channel names from input streams. More...
 
class  Daemon
 
class  FileLock
 
class  LDASplatform
 
class  LoggingInfo
 
class  MountPointStatus
 Monitors a list of directories. More...
 
class  StatBase
 
class  StatDirect
 
class  StatFork
 
class  StatPool
 
class  StatPoolT
 
class  StatStream
 
class  SymbolMapper
 

Typedefs

typedef boost::shared_ptr< GenericAPI::Log::LDASlog_type
 
typedef Log::LDAS LogEntryGroup_type
 
typedef struct stat stat_buf
 
typedef unordered_map< std::string, std::string > email_notify_container_type
 

Functions

const std::string & LogFileDefault ()
 Retrieve the default log file. More...
 
void CloseLog (const std::string &Filename=LogFileDefault())
 Close the requested log. More...
 
bool IsLogging (const int Group, const int Level, const std::string &Filename=LogFileDefault())
 Check if the message would be logged. More...
 
void LogFileDefault (const std::string &LogFilename)
 Establish the default output file for logging. More...
 
void queueLogEntry (const std::string &Message, const std::string &Group, const int Level, const std::string &Caller, const std::string &JobInfo, const unsigned int Time=0, const std::string &Filename=LogFileDefault())
 Queue a message to be written to a log file. More...
 
void queueLogEntry (const std::string &Message, const int Group, const int Level, const std::string &Caller, const std::string &JobInfo, const unsigned int Time=0, const std::string &Filename=LogFileDefault())
 Queue a message to be written to a log file. More...
 
void setLogDebugLevel (const int Level, const std::string &Filename=std::string(""))
 Establish level of debugging output. More...
 
void SetLogFormatter (const GenericAPI::Log::LDAS *Formatter)
 Establish how to format logging messages. More...
 
log_type LogFormatter (const std::string &Filename=LogFileDefault())
 Gain access to the current log formatter. More...
 
void setLogTag (const std::string &Tag)
 Establish tag used to identify logging set. More...
 
void SyncLog (const std::string &Filename=LogFileDefault())
 Wait till all log messages are written. More...
 
int lstat_interupt ()
 Query the interupt value. More...
 
int lstat_timeout ()
 Query the timeout value. More...
 
int SetStatTimeout (int Value)
 Establish the timeout value. More...
 
int Stat (const std::string &Filename, struct stat &StatBuffer)
 Perform timed stat call. More...
 
int LStat (const std::string &Filename, struct stat &StatBuffer)
 Perform timed lstat call. More...
 
int StatVFS (const std::string &Filename, struct statvfs &StatVFSBuffer)
 Returns information about a mounted file system. More...
 
void APINameGet (std::string &Name)
 
void APINameSet (const std::string &Name)
 
void EMailNotifyGet (const std::string &Name, std::string &Value)
 
void EMailNotifySet (const std::string &Name, const std::string &Value)
 
int StatVFS (const std::string &Filename, lStatVFS::buffer_type &StatVFSBuffer)
 
static MutexLock::baton_type EMailNotifyBaton (__FILE__, __LINE__)
 

Variables

static email_notify_container_type EMailNotify
 

Typedef Documentation

◆ email_notify_container_type

typedef unordered_map< std::string, std::string > GenericAPI::email_notify_container_type

◆ log_type

typedef boost::shared_ptr< GenericAPI::Log::LDAS > GenericAPI::log_type

◆ LogEntryGroup_type

◆ stat_buf

typedef struct stat GenericAPI::stat_buf

Function Documentation

◆ APINameGet()

void GenericAPI::APINameGet ( std::string &  Name)

◆ APINameSet()

void GenericAPI::APINameSet ( const std::string &  Name)

◆ CloseLog()

void GenericAPI::CloseLog ( const std::string &  Filename = LogFileDefault())

Close the requested log.

◆ EMailNotifyBaton()

static MutexLock::baton_type GenericAPI::EMailNotifyBaton ( __FILE__  ,
__LINE__   
)
static

◆ EMailNotifyGet()

void GenericAPI::EMailNotifyGet ( const std::string &  Name,
std::string &  Value 
)

◆ EMailNotifySet()

void GenericAPI::EMailNotifySet ( const std::string &  Name,
const std::string &  Value 
)

◆ IsLogging()

bool GenericAPI::IsLogging ( const int  Group,
const int  Level,
const std::string &  Filename = LogFileDefault() 
)

Check if the message would be logged.

Parameters
[in]GroupThe group classification of the message to be logged.
[in]LevelThe level at which the message will be logged.
[in]FilenameThe filename of the stream to send the message.
Returns
True if a message would be logged for the give Group at the given Level; false otherwise.

◆ LogFileDefault() [1/2]

const std::string & GenericAPI::LogFileDefault ( )

Retrieve the default log file.

◆ LogFileDefault() [2/2]

void GenericAPI::LogFileDefault ( const std::string &  LogFilename)

Establish the default output file for logging.

◆ LogFormatter()

log_type GenericAPI::LogFormatter ( const std::string &  Filename = LogFileDefault())

Gain access to the current log formatter.

◆ LStat()

int GenericAPI::LStat ( const std::string &  Filename,
struct stat &  StatBuffer 
)

Perform timed lstat call.

◆ lstat_interupt()

int GenericAPI::lstat_interupt ( )
inline

Query the interupt value.

◆ lstat_timeout()

int GenericAPI::lstat_timeout ( )

Query the timeout value.

◆ queueLogEntry() [1/2]

void GenericAPI::queueLogEntry ( const std::string &  Message,
const std::string &  Group,
const int  Level,
const std::string &  Caller,
const std::string &  JobInfo,
const unsigned int  Time = 0,
const std::string &  Filename = LogFileDefault() 
)

Queue a message to be written to a log file.

Parameters
[in]MessageThe text of the message to be written to the log file.
[in]GroupThe group classification of the message to be logged.
[in]LevelThe level at which the message will be logged.
[in]CallerThe function or method name of the routine logging the message.
[in]JobInfoDescriptive text of job logging the message.
[in]TimeThe time the message was logged.
[in]FilenameThe filename of the stream to send the message.

◆ queueLogEntry() [2/2]

void GenericAPI::queueLogEntry ( const std::string &  Message,
const int  Group,
const int  Level,
const std::string &  Caller,
const std::string &  JobInfo,
const unsigned int  Time = 0,
const std::string &  Filename = LogFileDefault() 
)

Queue a message to be written to a log file.

Parameters
[in]MessageThe text of the message to be written to the log file.
[in]GroupThe group classification of the message to be logged.
[in]LevelThe level at which the message will be logged.
[in]CallerThe function or method name of the routine logging the message.
[in]JobInfoDescriptive text of job logging the message.
[in]TimeThe time the message was logged.
[in]FilenameThe filename of the stream to send the message.

◆ setLogDebugLevel()

void GenericAPI::setLogDebugLevel ( const int  Level,
const std::string &  Filename = std::string("") 
)

Establish level of debugging output.

◆ SetLogFormatter()

void GenericAPI::SetLogFormatter ( const GenericAPI::Log::LDAS Formatter)

Establish how to format logging messages.

◆ setLogTag()

void GenericAPI::setLogTag ( const std::string &  Tag)

Establish tag used to identify logging set.

◆ SetStatTimeout()

int GenericAPI::SetStatTimeout ( int  Value)

Establish the timeout value.

◆ Stat()

int GenericAPI::Stat ( const std::string &  Filename,
struct stat &  StatBuffer 
)

Perform timed stat call.

◆ StatVFS() [1/2]

int GenericAPI::StatVFS ( const std::string &  Filename,
struct statvfs &  StatVFSBuffer 
)

Returns information about a mounted file system.

Parameters
[in]FilenameThe pathname of any file within the mounted filesystem.
[in,out]StatVFSBufferThe reference to a statvfs structure. If statvfs returns successfully, then information about the mounted filesystem containing Filename will be available in this structure.
Returns
Upon successful completion, the value zero is returned. Upon failure, the value -1 is returned and errno is set.

◆ StatVFS() [2/2]

int GenericAPI::StatVFS ( const std::string &  Filename,
lStatVFS::buffer_type &  StatVFSBuffer 
)

This function is a wrapper for the system level statvfs call. The use of this call adds the additional error condition of the call timing out. This is useful when querying NFS servers that are unresponsive.

◆ SyncLog()

void GenericAPI::SyncLog ( const std::string &  Filename = LogFileDefault())

Wait till all log messages are written.

Parameters
[in]FilenameThe filename of the stream to send the message.

Variable Documentation

◆ EMailNotify

email_notify_container_type GenericAPI::EMailNotify
static