RTI Distributed Logger API
Version 6.0.1
|
Customize RTI Distributed Logger using this API. More...
Data Structures | |
struct | RTI_DL_Options |
This struct contains all RTI Distributed Logger's configurable options. More... | |
Functions | |
RTI_DL_Options * | RTI_DL_Options_createDefault () |
Allocates memory for a RTI_DL_Options struct and sets the default values needed to create the Distributed Logger. | |
RTIBool | RTI_DL_Options_copy (RTI_DL_Options *self, const RTI_DL_Options *other) |
Create a copy of a RTI Distributed Logger options instance. | |
DDS_DomainParticipant * | RTI_DL_Options_getDomainParticipant (RTI_DL_Options *self) |
Gets the current DomainParticipant that will be used to create the RTI Distributed Logger's internal entities. | |
DDS_ReturnCode_t | RTI_DL_Options_setDomainParticipant (RTI_DL_Options *self, DDS_DomainParticipant *domainParticipant) |
Sets the DomainParticipant to be used to create RTI Distributed Logger internal entities. | |
RTIBool | RTI_DL_Options_getLogInfrastructureMessages (RTI_DL_Options *self) |
Indicates whether Distributed Logger should also log all messages produced by infrastructure code automatically. | |
DDS_ReturnCode_t | RTI_DL_Options_setLogInfrastructureMessages (RTI_DL_Options *self, RTIBool log) |
Enables or disables automatic logging of infrastructure messages. | |
RTIBool | RTI_DL_Options_isRemoteAdministrationEnabled (RTI_DL_Options *self) |
Indicates whether remote administration is enabled or not. | |
DDS_ReturnCode_t | RTI_DL_Options_setRemoteAdministrationEnabled (RTI_DL_Options *self, RTIBool enabled) |
Enables or disables remote administration. | |
int | RTI_DL_Options_getFilterLevel (RTI_DL_Options *self) |
Gets the log filter level. | |
DDS_ReturnCode_t | RTI_DL_Options_setFilterLevel (RTI_DL_Options *self, int filterLevel) |
Sets the log filter level. | |
int | RTI_DL_Options_getDomainId (RTI_DL_Options *self) |
Gets the current Domain ID. | |
DDS_ReturnCode_t | RTI_DL_Options_setDomainId (RTI_DL_Options *self, int domainId) |
Sets the current Domain ID. | |
char * | RTI_DL_Options_getQosLibrary (RTI_DL_Options *self) |
Gets the Qos Library that will be used to create to RTI Distributed Logger. | |
DDS_ReturnCode_t | RTI_DL_Options_setQosLibrary (RTI_DL_Options *self, const char *qosLibrary) |
Sets the Qos Library that will be used to create to RTI Distributed Logger. | |
char * | RTI_DL_Options_getQosProfile (RTI_DL_Options *self) |
Gets the Qos Profile that will be used to create to RTI Distributed Logger. | |
DDS_ReturnCode_t | RTI_DL_Options_setQosProfile (RTI_DL_Options *self, const char *qosProfile) |
Sets the Qos Profile that will be used to create to RTI Distributed Logger. | |
int | RTI_DL_Options_getQueueSize (RTI_DL_Options *self) |
Gets the maximum queue size that will be assigned to RTI Distributed Logger. | |
DDS_ReturnCode_t | RTI_DL_Options_setQueueSize (RTI_DL_Options *self, int queueSize) |
Sets the maximum queue size that will be assigned to RTI Distributed Logger. | |
struct DDS_ThreadSettings_t * | RTI_DL_Options_getThreadSettings (RTI_DL_Options *self) |
Gets the thread settings of the publishing thread that will be created by RTI Distributed Logger. | |
DDS_ReturnCode_t | RTI_DL_Options_setThreadSettings (RTI_DL_Options *self, const struct DDS_ThreadSettings_t *threadSettings) |
Sets the settings of the publishing thread that will be created by RTI Distributed Logger. | |
char * | RTI_DL_Options_getApplicationKind (RTI_DL_Options *self) |
Gets the application kind that will be associated with RTI Distributed Logger. | |
DDS_ReturnCode_t | RTI_DL_Options_setApplicationKind (RTI_DL_Options *self, const char *applicationKind) |
Sets the application kind that will be associated with RTI Distributed Logger. | |
RTIBool | RTI_DL_Options_getEchoToStdout (RTI_DL_Options *self) |
Gets the current value of echoToStdout option. | |
DDS_ReturnCode_t | RTI_DL_Options_setEchoToStdout (RTI_DL_Options *self, RTIBool echoToStdout) |
Sets the value of echoToStdout flag. | |
RTI_DL_Options * | RTI_DL_Options_delete (RTI_DL_Options *self) |
Releases memory for a RTI_DL_Options. Checks whether the pointer exists or not. | |
Customize RTI Distributed Logger using this API.
RTI_DL_Options* RTI_DL_Options_createDefault | ( | ) |
Allocates memory for a RTI_DL_Options struct and sets the default values needed to create the Distributed Logger.
RTIBool RTI_DL_Options_copy | ( | RTI_DL_Options * | self, |
const RTI_DL_Options * | other | ||
) |
Create a copy of a RTI Distributed Logger options instance.
This method creates a deep copy of a RTI Distributed Logger options object.
[out] | self | Already created RTI_DL_Options struct where we want to copy the values in. |
[in] | other | RTI_DL_Options containing the values to be copied in self . |
true
. Otherwise it returns false
. DDS_DomainParticipant* RTI_DL_Options_getDomainParticipant | ( | RTI_DL_Options * | self | ) |
Gets the current DomainParticipant that will be used to create the RTI Distributed Logger's internal entities.
If a customized DomainParticipant has been set, this function returns a pointer to it. If this field is not null, this is the DomainParticipant. Otherwise, it returns the default value, NULL.
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setDomainParticipant | ( | RTI_DL_Options * | self, |
DDS_DomainParticipant * | domainParticipant | ||
) |
Sets the DomainParticipant to be used to create RTI Distributed Logger internal entities.
There are several use cases in which you may want to use your own DomainParticipant to create RTI Distributed Logger internal DDS entities. By calling this function, you will have control of the DomainParticipant used by RTI Distributed Logger. Once assigned, domainParticipant will
be used to create the DDS entities (Topics, Publishers, Subscribers, DataWriters, & DataReaders) needed by RTI Distributed Logger.
When the DomainParticipant is set to a non-NULL value, it is the user's responsibility to handle the memory associated with it.
[in,out] | self | Pointer to a working RTI_DL_Options struct |
[in] | domainParticipant | Pointer to a valid DDS_DomainParticipant |
RTIBool RTI_DL_Options_getLogInfrastructureMessages | ( | RTI_DL_Options * | self | ) |
Indicates whether Distributed Logger should also log all messages produced by infrastructure code automatically.
If true, messages produced by either the middleware or the tools will be forwarded to Distributed Logger.
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setLogInfrastructureMessages | ( | RTI_DL_Options * | self, |
RTIBool | log | ||
) |
Enables or disables automatic logging of infrastructure messages.
If true, messages produced by either the middleware or the tools will be forwarded to Distributed Logger. In this mode Distributed Logger uses NDDS_Config_Logger_set_output_device() API to receive messages from the middleware. Hence any device previously registered with NDDS_Config_Logger_set_output_device() API will be unregistered. Similarly Distributed Logger will stop logging infrastructure messages if the set_output_device() API is used to register a new device after the creation of the Distributed Logger instance.
[in,out] | self | Pointer to a working RTI_DL_Options struct |
[in] | log | Boolean indicating whether to enable this feature. |
RTIBool RTI_DL_Options_isRemoteAdministrationEnabled | ( | RTI_DL_Options * | self | ) |
Indicates whether remote administration is enabled or not.
If true, remote administration Topics will be created and used. If false, they will not be created. The default value is true.
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setRemoteAdministrationEnabled | ( | RTI_DL_Options * | self, |
RTIBool | enabled | ||
) |
Enables or disables remote administration.
Sets remote administration of the Topics to the value passed as a parameter.
[in,out] | self | Pointer to a working RTI_DL_Options struct |
[in] | enabled | Boolean indicating new remote administration value. |
int RTI_DL_Options_getFilterLevel | ( | RTI_DL_Options * | self | ) |
Gets the log filter level.
Supported Filter Levels: See the IDL file provided with RTI Distributed Logger (<RTI Connext Installation Folder>/resource/idl/distlog.idl)
The default value is RTI_DL_INFO_LEVEL.
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setFilterLevel | ( | RTI_DL_Options * | self, |
int | filterLevel | ||
) |
Sets the log filter level.
Filtering controls what type of log messages are sent. This enables filtering on the sending side (in the application using RTI 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 RTI Distributed Logger (<RTI Connext Installation Folder>/resource/idl/distlog.idl). The default value is RTI_DL_INFO_LEVEL.
[in,out] | self | Pointer to a working RTI_DL_Options struct |
[in] | filterLevel | Integer containing the log filter level value of the options. |
int RTI_DL_Options_getDomainId | ( | RTI_DL_Options * | self | ) |
Gets the current Domain ID.
Returns the Domain ID to be used by RTI Distributed Logger. This value is only used if RTI_DL_Options_setDomainParticipant has NOT been called. Otherwise, the Domain ID used is the one of the DomainParticipant assigned
The default value is 0.
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setDomainId | ( | RTI_DL_Options * | self, |
int | domainId | ||
) |
Sets the current Domain ID.
Updated the Domain ID to be used by RTI Distributed Logger. This value is only used if RTI_DL_Options_setDomainParticipant has NOT been called. Otherwise, the Domain ID used is the one of the DomainParticipant assigned.
The default value is 0.
[in,out] | self | Pointer to a working RTI_DL_Options struct. |
[in] | domainId | Integer representing a DDS Domain ID. Max value 250. |
char* RTI_DL_Options_getQosLibrary | ( | RTI_DL_Options * | self | ) |
Gets the Qos Library that will be used to create to RTI Distributed Logger.
The QoS library name to use when creating DDS entities. It is up to the application to ensure that this library is available at runtime for RTI Distributed Logger to use. The default value is "".
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setQosLibrary | ( | RTI_DL_Options * | self, |
const char * | qosLibrary | ||
) |
Sets the Qos Library that will be used to create to RTI Distributed Logger.
The QoS library name to use when creating DDS entities. It is up to the application to ensure that this library is available at run time for the Distributed Logger to use.
[in,out] | self | Pointer to a working RTI_DL_Options struct. |
[in] | qosLibrary | Pointer to a char containing the new Qos Library. A copy of the string is made. |
char* RTI_DL_Options_getQosProfile | ( | RTI_DL_Options * | self | ) |
Gets the Qos Profile that will be used to create to RTI Distributed Logger.
The QoS profile name to use when creating DDS entities. It is up to the application to ensure that this profile is available at run time for the Distributed Logger to use. The default value is "".
[in] | self | Pointer to a working RTI_DL_Options struct. |
DDS_ReturnCode_t RTI_DL_Options_setQosProfile | ( | RTI_DL_Options * | self, |
const char * | qosProfile | ||
) |
Sets the Qos Profile that will be used to create to RTI Distributed Logger.
The QoS profile name to use when creating DDS entities. It is up to the application to ensure that this profile is available at run time for the Distributed Logger to use.
[in,out] | self | Pointer to a working RTI_DL_Options struct. |
[in] | qosProfile | Pointer to a char containing the new Qos profile. A copy of the string is made. |
int RTI_DL_Options_getQueueSize | ( | RTI_DL_Options * | self | ) |
Gets the maximum queue size that will be assigned to RTI Distributed Logger.
This field controls the size of the queue used to temporarily store log messages from the application until they can be written out to DDS. The default value is RTI_DL_DEFAULT_QUEUE_SIZE.
[in] | self | Pointer to a working RTI_DL_Options struct |
DDS_ReturnCode_t RTI_DL_Options_setQueueSize | ( | RTI_DL_Options * | self, |
int | queueSize | ||
) |
Sets the maximum queue size that will be assigned to RTI Distributed Logger.
This field controls the size of the queue used to temporarily store log messages from the application until they can be written out to DDS.
[in,out] | self | Pointer to a working RTI_DL_Options struct. |
[in] | queueSize | Integer containing the new maximum queue size. |
|
read |
Gets the thread settings of the publishing thread that will be created by RTI Distributed Logger.
This fields controls the priority of the thread that sends the messages through DDS. The default values are defined in dds_c_infrastructure.h.
[in] | self | Pointer to a working RTI_DL_Options struct. |
DDS_ReturnCode_t RTI_DL_Options_setThreadSettings | ( | RTI_DL_Options * | self, |
const struct DDS_ThreadSettings_t * | threadSettings | ||
) |
Sets the settings of the publishing thread that will be created by RTI Distributed Logger.
This field controls the settings of the thread that sends the messages through DDS. These settings only affect the publishing thread created by RTI Distributed Logger.
[in,out] | self | Pointer to a working RTI_DL_Options struct. |
[in] | threadSettings | The thread settings to apply to the options. Must be a valid RTI_OSAPI_THREAD_PRIORITY value. |
char* RTI_DL_Options_getApplicationKind | ( | RTI_DL_Options * | self | ) |
Gets the application kind that will be associated with RTI Distributed Logger.
This string is sent along on the state Topic and can help identify different applications within a system. You can use this field however you think it will help you most. The default value is "".
[in] | self | Pointer to a working RTI_DL_Options struct. |
DDS_ReturnCode_t RTI_DL_Options_setApplicationKind | ( | RTI_DL_Options * | self, |
const char * | applicationKind | ||
) |
Sets the application kind that will be associated with RTI Distributed Logger.
This string is sent along on the state Topic and can help identify different applications within a system. You can use this field however you think it will help you most. The default value is "".
[in,out] | self | Pointer to a working RTI_DL_Options struct. |
[in] | applicationKind | Pointer to a string containing the new application kind. |
RTIBool RTI_DL_Options_getEchoToStdout | ( | RTI_DL_Options * | self | ) |
Gets the current value of echoToStdout option.
If true, RTI Distributed Logger prints the log messages received to the stdout. The default value is TRUE.
[in] | self | Pointer to a working RTI_DL_Options. |
DDS_ReturnCode_t RTI_DL_Options_setEchoToStdout | ( | RTI_DL_Options * | self, |
RTIBool | echoToStdout | ||
) |
Sets the value of echoToStdout flag.
If true, RTI Distributed Logger prints the log messages received to the stdout. The default value is TRUE.
[in,out] | self | Pointer to a working RTI_DL_Options. |
[in] | echoToStdout | New value of set self.echoToStdout. |
RTI_DL_Options* RTI_DL_Options_delete | ( | RTI_DL_Options * | self | ) |
Releases memory for a RTI_DL_Options. Checks whether the pointer exists or not.
[in] | self | Pointer to a working RTI_DL_Options struct. Checks whether the parameter is NULL or not. |
self->domainParticipant
will not be deleted.