GemStone::GemFire::Cache::Generic::Log Class Reference


Detailed Description

Defines methods available to clients that want to write a log message to their GemFire system's shared log file.

Any attempt to use an instance after its connection is disconnected will throw a NotConnectedException.

For any logged message the log file will contain:

A message always has a level. Logging levels are ordered. Enabling logging at a given level also enables logging at higher levels. The higher the level the more important and urgent the message.

The levels, in descending order of severity, are:


Static Public Member Functions

static void Close ()
static void Config (String^ format,...array< Object^ >^args)
static void Debug (String^ format,...array< Object^ >^args)
static bool Enabled (LogLevel level)
static void Error (String^ format,...array< Object^ >^args)
static void Fine (String^ format,...array< Object^ >^args)
static void Finer (String^ format,...array< Object^ >^args)
static void Finest (String^ format,...array< Object^ >^args)
static void Info (String^ format,...array< Object^ >^args)
static void Init (LogLevel level, String^ logFileName, int32_t logFileLimit)
static void Init (LogLevel level, String^ logFileName)
static LogLevel Level ()
static void LogCatch (LogLevel level, String^ msg, System::Exception^ ex)
static String^ LogFileName ()
static void LogThrow (LogLevel level, String^ msg, System::Exception^ ex)
static void SetLevel (LogLevel level)
static void Warning (String^ format,...array< Object^ >^args)
static void Write (LogLevel level, String^ msg)

Member Function Documentation

static void GemStone::GemFire::Cache::Generic::Log::Close (  )  [static]

Closes logging facility (until next init).

static void GemStone::GemFire::Cache::Generic::Log::Config ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Config level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Debug ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Debug level logging with variable number of arguments using format as in System.String.Format.

static bool GemStone::GemFire::Cache::Generic::Log::Enabled ( LogLevel  level  )  [static]

True if log messages at the given level are enabled.

static void GemStone::GemFire::Cache::Generic::Log::Error ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Error level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Fine ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Fine level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Finer ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Finer level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Finest ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Finest level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Info ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Info level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Init ( LogLevel  level,
String^   logFileName,
int32_t  logFileLimit 
) [static]

Initializes logging facility with given level, filename, and file size limit.

Parameters:
level the logging level
logFileName the log file name
logFileLimit maximum allowable size of the log file, in bytes, or 0 for the default (1 Gbyte)

static void GemStone::GemFire::Cache::Generic::Log::Init ( LogLevel  level,
String^   logFileName 
) [static]

Initializes the logging facility with the given level and filename.

Parameters:
level the logging level
logFileName the log file name

static LogLevel GemStone::GemFire::Cache::Generic::Log::Level (  )  [static]

Returns the current log level.

static void GemStone::GemFire::Cache::Generic::Log::LogCatch ( LogLevel  level,
String^   msg,
System::Exception^   ex 
) [static]

Logs both a message and a caught exception.

static String ^ GemStone::GemFire::Cache::Generic::Log::LogFileName (  )  [static]

Returns the name of the current log file. NOTE: This function is for debugging only, as it is not completely thread-safe!

static void GemStone::GemFire::Cache::Generic::Log::LogThrow ( LogLevel  level,
String^   msg,
System::Exception^   ex 
) [static]

Logs both a message and a thrown exception.

static void GemStone::GemFire::Cache::Generic::Log::SetLevel ( LogLevel  level  )  [static]

Sets the current log level.

static void GemStone::GemFire::Cache::Generic::Log::Warning ( String^   format,
...array< Object^ >^  args 
) [inline, static]

Warning level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Generic::Log::Write ( LogLevel  level,
String^   msg 
) [static]

Logs a message at the given level.


GemFire C++ Cache .NET API Documentation