RTI Distributed Logger API  Version 5.3.1
 All Classes Functions Variables
Options Class Reference

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
 

Detailed Description

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.

Author
RTI

Constructor & Destructor Documentation

Options ( )

The constructor to create a new instance of the Options class.

Member Function Documentation

boolean isEchoToStdout ( )
Returns
true if echoing messages to stdout, false otherwise.
void setEchoToStdout ( boolean  echoToStdout)
Parameters
echoToStdoutSet to true to echo messages to stdout, false otherwise.
boolean getLogInfrastructureMessages ( )
Returns
true if Distributed Logger should log messages produced by other RTI products (tools, middleware, etc)
void setLogInfrastructureMessages ( boolean  log)
Parameters
logtrue if Distributed Logger should log messages produced by other RTI products (tools, middleware, etc)
DomainParticipant getDomainParticipant ( )
Returns
The 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.

Parameters
domainParticipantThe DomainParticipant cannot be null.
boolean isRemoteAdministrationEnabled ( )
Returns
true if remote administration is enabled, false otherwise.
void setRemoteAdministrationEnabled ( boolean  enableRemoteAdministration)

Set whether or not remote administration will be used.

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

Returns
The filter level. Messages with a less-verbose level will be filtered out and not sent.
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.

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

Filter Levels
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 ( )
Returns
The domain id which will be associated with all of the Distributed Logger topics.
void setDomainId ( int  domainId)

Set the domain id to use for connecting to DDS.

Parameters
domainIdThe new domain id must be >= 0.
String getQosLibrary ( )
Returns
The QoS library name used when creating DDS entities.
void setQosLibrary ( String  qosLibrary)

Set the QoS library name used when creating DDS entities.

Parameters
qosLibraryThe QoS library name.
String getQosProfile ( )
Returns
The QoS profile name used when creating DDS entities.
void setQosProfile ( String  qosProfile)

Set the QoS profile name used when creating DDS entities.

Parameters
qosProfileThe QoS profile name.
int getThreadPriority ( )
Returns
The thread priority of the thread that publishes the log messages to DDS.
void setThreadPriority ( int  threadPriority)

Set the thread priority of the publishing thread.

Parameters
threadPriorityMust be >= Thread.MIN_PRIORITY and <= Thread.MAX_PRIORITY.
int getQueueSize ( )
Returns
The queue size used to buffer log messages until they are written to DDS.
void setQueueSize ( int  queueSize)

Sets the queue size.

Parameters
queueSizeMust be > 0.
String getApplicationKind ( )
Returns
The application kind string.
void setApplicationKind ( String  applicationKind)

Set the application kind string. This string can be used for any purpose that is useful or interesting.

Parameters
applicationKindA string to be associated with the Distributed Logger.

Member Data Documentation

final int DEFAULT_QUEUE_SIZE = 128
static

The default size for the queue that stores log messages waiting to be written to DDS.


RTI Distributed Logger API Version 5.3.1 Copyright © Mon Mar 5 2018 Real-Time Innovations, Inc