RTI Connext Java API  Version 5.0.0
Logger Class Reference

<<interface>> The singleton type used to configure RTI Connext logging. More...

Public Member Functions

LogVerbosity get_verbosity ()
 Get the verbosity at which RTI Connext is currently logging diagnostic information.
 
LogVerbosity get_verbosity_by_category (LogCategory category)
 Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.
 
void set_verbosity (LogVerbosity verbosity)
 Set the verbosity at which RTI Connext will log diagnostic information.
 
void set_verbosity_by_category (LogCategory category, LogVerbosity verbosity)
 Set the verbosity at which RTI Connext will log diagnostic information in the given category.
 
File get_output_file ()
 Get the file to which the logged output is redirected.
 
void set_output_file (File out) throws IOException
 Set the file to which the logged output is redirected.
 
LoggerDevice get_output_device ()
 Return the user device registered with the logger.
 
void set_output_device (LoggerDevice device) throws IOException
 Register a com.rti.ndds.config.LoggerDevice.
 
LogPrintFormat get_print_format ()
 Get the current message format that RTI Connext is using to log diagnostic information.
 
boolean set_print_format (LogPrintFormat print_format)
 Set the message format that RTI Connext will use to log diagnostic information.
 

Static Public Member Functions

static Logger get_instance ()
 Get the singleton instance of this type.
 

Detailed Description

<<interface>> The singleton type used to configure RTI Connext logging.

Member Function Documentation

static Logger get_instance ( )
static

Get the singleton instance of this type.

LogVerbosity get_verbosity ( )

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

The default verbosity if com.rti.ndds.config.Logger.set_verbosity is never called is com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR.

If com.rti.ndds.config.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.

LogVerbosity get_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 com.rti.ndds.config.Logger.set_verbosity and com.rti.ndds.config.Logger.set_verbosity_by_category are never called is com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR.

void set_verbosity ( LogVerbosity  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 com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_WARNING or below. (The default verbosity if you never set it is com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR.)

void set_verbosity_by_category ( LogCategory  category,
LogVerbosity  verbosity 
)

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

File get_output_file ( )

Get the file to which the logged output is redirected.

If no output file has been registered through com.rti.ndds.config.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 set_output_file ( File  out) throws IOException

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).

LoggerDevice get_output_device ( )

Return the user device registered with the logger.

Returns
Registered user device or NULL if no user device is registered.
void set_output_device ( LoggerDevice  device) throws IOException

Register a com.rti.ndds.config.LoggerDevice.

Register the specified logging device with the logger.

There can be at most only one device registered with the logger at any given time.

When a device is installed, the logger will stop sending the log messages to the standard output and to the file set with com.rti.ndds.config.Logger.set_output_file.

To remove an existing device, use this method with NULL as the device parameter. After a device is removed the logger will continue sending log messages to the standard output and to the output file.

To replace an existing device with a new device, use this method providing the new device as the device parameter.

When a device is unregistered (by setting it to NULL), com.rti.ndds.config.LoggerDevice calls the method com.rti.ndds.config.LoggerDevice.close.

Parameters
device<<in>> Logging device.
LogPrintFormat get_print_format ( )

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

If com.rti.ndds.config.Logger.set_print_format is never called, the default format is com.rti.ndds.config.LogPrintFormat.NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

boolean set_print_format ( LogPrintFormat  print_format)

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


RTI Connext Java API Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc