rti::config::Logger Class Reference

The singleton type used to configure RTI Connext logging. More...

#include <Logger.hpp>

Public Member Functions
Verbosity	verbosity ()
	Get the verbosity at which RTI Connext is currently logging diagnostic information.
Verbosity	verbosity_by_category (LogCategory category)
	Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.
void	verbosity (Verbosity verbosity)
	Set the verbosity at which RTI Connext will log diagnostic information.
void	verbosity_by_category (LogCategory category, Verbosity verbosity)
	Set the verbosity at which RTI Connext will log diagnostic information in the given category.
FILE *	output_file ()
	Get the file to which the logged output is redirected.
void	output_file (FILE *out)
	Set the file to which the logged output is redirected.
void	output_file (const char *file_name)
	Set the name of the file to which the logged output is redirected.
void	output_file_set (const char *file_preffix, const char *file_suffix, int max_bytes, int max_files=dds::core::LENGTH_UNLIMITED)
	Set the name of the file to which the logged output is redirected.
PrintFormat	print_format ()
	Get the current message format that RTI Connext is using to log diagnostic information.
void	print_format (PrintFormat print_format)
	Set the message format that RTI Connext will use to log diagnostic information.

Static Public Member Functions
static Logger &	instance ()
	Get the singleton instance of this type.

Detailed Description

The singleton type used to configure RTI Connext logging.

Member Function Documentation

static Logger& rti::config::Logger::instance ( )

static

Get the singleton instance of this type.

Verbosity rti::config::Logger::verbosity

(

)

Get the verbosity at which RTI Connext is currently logging diagnostic information.

The default verbosity if Logger::set_verbosity is never called is rti::core::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_ERROR.

If Logger::set_verbosity_by_category has been used to set different verbosities for different categories of messages, this method will return the maximum verbosity of all categories.

Verbosity rti::config::Logger::verbosity_by_category

(

LogCategory

category

)

Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.

The default verbosity if Logger::set_verbosity and Logger::set_verbosity_by_category are never called is rti::core::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_ERROR.

void rti::config::Logger::verbosity

(

Verbosity

verbosity

)

Set the verbosity at which RTI Connext will log diagnostic information.

Note: Logging at high verbosities will be detrimental to your application's performance. Your default setting should typically remain at rti::core::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_WARNING or below. (The default verbosity if you never set it is rti::core::LogVerbosity::NDDS_CONFIG_LOG_VERBOSITY_ERROR.)

void rti::config::Logger::verbosity_by_category	(	LogCategory	category,
		Verbosity	verbosity
	)

Set the verbosity at which RTI Connext will log diagnostic information in the given category.

FILE* rti::config::Logger::output_file

(

)

Get the file to which the logged output is redirected.

If no output file has been registered through Logger::set_output_file, this method will return NULL. In this case, logged output will on most platforms go to standard out as if through printf.

void rti::config::Logger::output_file

(

FILE *

out

)

Set the file to which the logged output is redirected.

The file passed may be NULL, in which case further logged output will be redirected to the platform-specific default output location (standard out on most platforms).

void rti::config::Logger::output_file

(

const char *

file_name

)

Set the name of the file to which the logged output is redirected.

The name may be NULL, in which case further logged output will be redirected to the platform-specific default output location (standard out on most platforms).

void rti::config::Logger::output_file_set	(	const char *	file_preffix,
		const char *	file_suffix,
		int	max_bytes,
		int	max_files = dds::core::LENGTH_UNLIMITED
	)

Set the name of the file to which the logged output is redirected.

The name may be NULL, in which case further logged output will be redirected to the platform-specific default output location (standard out on most platforms).

PrintFormat rti::config::Logger::print_format

(

)

Get the current message format that RTI Connext is using to log diagnostic information.

If Logger::set_print_format is never called, the default format is LogPrintFormat::NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

void rti::config::Logger::print_format

(

PrintFormat

print_format

)

Set the message format that RTI Connext will use to log diagnostic information.