RTI Distributed Logger API
Version 6.1.0
|
Public Member Functions | |
boolean | isEchoToStdout () |
void | setEchoToStdout (boolean echoToStdout) |
boolean | getLogInfrastructureMessages () |
void | setLogInfrastructureMessages (boolean log) |
Options () | |
DomainParticipant | getDomainParticipant () |
void | setDomainParticipant (DomainParticipant domainParticipant) |
boolean | isRemoteAdministrationEnabled () |
void | setRemoteAdministrationEnabled (boolean enableRemoteAdministration) |
int | getFilterLevel () |
void | setFilterLevel (int filterLevel) |
int | getDomainId () |
void | setDomainId (int domainId) |
String | getQosLibrary () |
void | setQosLibrary (String qosLibrary) |
String | getQosProfile () |
void | setQosProfile (String qosProfile) |
int | getThreadPriority () |
void | setThreadPriority (int threadPriority) |
int | getQueueSize () |
void | setQueueSize (int queueSize) |
String | getApplicationKind () |
void | setApplicationKind (String applicationKind) |
Static Public Attributes | |
static final int | DEFAULT_QUEUE_SIZE = 128 |
This class contains the runtime options for the Distributed Logger. It is important to note that these options can only be set before the Distributed Logger has been instantiated.
Options | ( | ) |
The constructor to create a new instance of the Options
class.
References Options.DEFAULT_QUEUE_SIZE.
boolean isEchoToStdout | ( | ) |
Referenced by DistLogger.log().
void setEchoToStdout | ( | boolean | echoToStdout | ) |
echoToStdout | Set to true to echo messages to stdout, false otherwise. |
boolean getLogInfrastructureMessages | ( | ) |
Referenced by DistLogger.delete(), and DistLogger.setOptions().
void setLogInfrastructureMessages | ( | boolean | log | ) |
log | true if Distributed Logger should log messages produced by other RTI products (tools, middleware, etc) |
DomainParticipant getDomainParticipant | ( | ) |
DomainParticipant
to be used for creating DDS entities. Note that this can be null. void setDomainParticipant | ( | DomainParticipant | domainParticipant | ) |
Set the DomainParticipant
to use when creating DDS entities to support the distribution of log messages.
domainParticipant | The DomainParticipant cannot be null. |
boolean isRemoteAdministrationEnabled | ( | ) |
Referenced by DistLogger.setOptions().
void setRemoteAdministrationEnabled | ( | boolean | enableRemoteAdministration | ) |
Set whether or not remote administration will be used.
enableRemoteAdministration |
int getFilterLevel | ( | ) |
Get the filter level.
Supported Filter Levels: See the IDL file provided with Distributed Logger (ndds.<version>/resource/rtidistlogger/idl/rtidistlog.idl)
The default value is INFO_LEVEL. See setFilterLevel() for more information on filter levels.
Referenced by DistLogger.setOptions().
void setFilterLevel | ( | int | filterLevel | ) |
Sets the filter level.
Filtering controls what type of log messages are sent. This enables filtering on the sending side (in the application using Distributed Logger). You can also enable filtering on the receiving side (such as in a tool that receives log messages, like RTI Admin Console or RTI Monitor).
Supported Filter Levels: See the IDL file provided with Distributed Logger (file: ndds.<version>/resource/rtidistlogger/idl/rtidistlog.idl). The default value is INFO_LEVEL. In the IDL file, there are language-specific bindings. Prepend the appropriate binding to the filter level shown in the IDL. For example, one of the filter levels in the IDL is INFO_LEVEL. To refer to this filter level in Java, use com.rti.dl.INFO_LEVEL.VALUE.
Log messages, up to and including the specified filter level, will pass through the filter and be sent on the network. For example, the WARNING level allows log messages up to and including the WARNING level (FATAL, SEVERE, ERROR, and WARNING) to be sent; any other log messages with numerically higher filter levels (INFO, DEBUG, and TRACE) will be filtered out and not sent.
filterLevel | The new filter level. This value must be >= SILENT_LEVEL.VALUE . |
The following table shows how Connext log levels map to Distributed Logger log filter levels. Not all Distributed Logger levels appear in this table because there is not a one-to-one mapping between Connext and Distributed Logger levels (there are more levels in Distributed Logger).
Connext | Distributed Logger |
---|---|
NDDS_CONFIG_LOG_LEVEL_ERROR | ERROR_LEVEL |
NDDS_CONFIG_LOG_LEVEL_WARNING | WARNING_LEVEL |
NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL | NOTICE_LEVEL |
NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE | INFO_LEVEL |
NDDS_CONFIG_LOG_LEVEL_DEBUG | DEBUG_LEVEL |
int getDomainId | ( | ) |
void setDomainId | ( | int | domainId | ) |
Set the domain id to use for connecting to DDS.
domainId | The new domain id must be >= 0. |
String getQosLibrary | ( | ) |
void setQosLibrary | ( | String | qosLibrary | ) |
Set the QoS library name used when creating DDS entities.
qosLibrary | The QoS library name. |
String getQosProfile | ( | ) |
void setQosProfile | ( | String | qosProfile | ) |
Set the QoS profile name used when creating DDS entities.
qosProfile | The QoS profile name. |
int getThreadPriority | ( | ) |
Referenced by DistLogger.setOptions().
void setThreadPriority | ( | int | threadPriority | ) |
Set the thread priority of the publishing thread.
threadPriority | Must be >= Thread.MIN_PRIORITY and <= Thread.MAX_PRIORITY . |
int getQueueSize | ( | ) |
Referenced by DistLogger.setOptions().
void setQueueSize | ( | int | queueSize | ) |
Sets the queue size.
queueSize | Must be > 0. |
String getApplicationKind | ( | ) |
Referenced by DistLogger.setOptions().
void setApplicationKind | ( | String | applicationKind | ) |
Set the application kind string. This string can be used for any purpose that is useful or interesting.
applicationKind | A string to be associated with the Distributed Logger. |
|
static |
The default size for the queue that stores log messages waiting to be written to DDS.
Referenced by Options.Options().