Data Structures
struct	RTI_DL_Options
	This struct contains all the DistLogger's configurable options. More...

Functions
RTIDLCDllExport RTI_DL_Options *	RTI_DL_Options_createDefault ()
	Allocate memory for a RTI_DL_Options struct and set the default values needed to create the Distributed Logger.

RTIDLCDllExport DDS_DomainParticipant *	RTI_DL_Options_getDomainParticipant (RTI_DL_Options *self)
	Gets current Domain Participant.

RTIDLCDllExport void	RTI_DL_Options_setDomainParticipant (RTI_DL_Options self, DDS_DomainParticipant domainParticipant)
	Sets current Domain Participant.

RTIDLCDllExport RTIBool	RTI_DL_Options_isRemoteAdministrationEnabled (RTI_DL_Options *self)
	Gets whether remote administration is enabled or not.

RTIDLCDllExport void	RTI_DL_Options_setRemoteAdministrationEnabled (RTI_DL_Options *self, RTIBool enabled)
	Enables or disables remote administration.

RTIDLCDllExport int	RTI_DL_Options_getFilterLevel (RTI_DL_Options *self)
	Gets the log level.

RTIDLCDllExport void	RTI_DL_Options_setFilterLevel (RTI_DL_Options *self, int filterLevel)
	Sets the log level.

RTIDLCDllExport int	RTI_DL_Options_getDomainId (RTI_DL_Options *self)
	Gets the current domain id.

RTIDLCDllExport void	RTI_DL_Options_setDomainId (RTI_DL_Options *self, int domainId)
	Sets the current domain id.

RTIDLCDllExport char *	RTI_DL_Options_getQosLibrary (RTI_DL_Options *self)
	Gets the Qos Library.

RTIDLCDllExport void	RTI_DL_Options_setQosLibrary (RTI_DL_Options self, const char qosLibrary)
	Sets the Qos Library.

RTIDLCDllExport char *	RTI_DL_Options_getQosProfile (RTI_DL_Options *self)
	Gets the Qos Profile.

RTIDLCDllExport void	RTI_DL_Options_setQosProfile (RTI_DL_Options self, const char qosProfile)
	Sets the Qos Profile.

RTIDLCDllExport int	RTI_DL_Options_getQueueSize (RTI_DL_Options *self)
	Gets the maximum queue size.

RTIDLCDllExport void	RTI_DL_Options_setQueueSize (RTI_DL_Options *self, int queueSize)
	Sets the maximum queue size.

RTIDLCDllExport struct DDS_ThreadSettings_t *	RTI_DL_Options_getThreadSettings (RTI_DL_Options *self)
	Gets the thread settings of the publishing thread.

RTIDLCDllExport void	RTI_DL_Options_setThreadSettings (RTI_DL_Options self, const struct DDS_ThreadSettings_t threadSettings)
	Sets the settings of the publishing thread.

RTIDLCDllExport char *	RTI_DL_Options_getApplicationKind (RTI_DL_Options *self)
	Gets the application kind.

RTIDLCDllExport void	RTI_DL_Options_setApplicationKind (RTI_DL_Options self, const char applicationKind)
	Sets the application kind.

RTIDLCDllExport RTIBool	RTI_DL_Options_getEchoToStdout (RTI_DL_Options *self)
	Gets the current value of echoToStdout.

RTIDLCDllExport void	RTI_DL_Options_setEchoToStdout (RTI_DL_Options *self, RTIBool echoToStdout)
	Sets the value of echoToStdout.

RTIDLCDllExport RTI_DL_Options *	RTI_DL_Options_delete (RTI_DL_Options *self)
	Release memory for a RTI_DL_Options struct. Checks whether the pointer exists or not.

Detailed Description

Function Documentation

RTIDLCDllExport RTI_DL_Options* RTI_DL_Options_createDefault ( )

Allocate memory for a RTI_DL_Options struct and set the default values needed to create the Distributed Logger.

Returns: Pointer to a working RTI_DL_Options struct

Postcondition: Memory must be release using RTI_DL_Options_delete

See Also: RTI_DL_Options_delete()

RTIDLCDllExport DDS_DomainParticipant* RTI_DL_Options_getDomainParticipant ( RTI_DL_Options * self )

Gets current Domain Participant.

If this field is not null, then this is the DomainParticipant that will be used to create DDS entities (Topics, Publishers, Subscribers, DataWriters, & DataReaders) needed by the Distributed Logger. The default value is NULL.

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: Pointer to the DDS_DomainParticipant contained in the struct.

RTIDLCDllExport void RTI_DL_Options_setDomainParticipant	(	RTI_DL_Options *	self,
		DDS_DomainParticipant *	domainParticipant
	)

Sets current Domain Participant.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	domainParticipant	Pointer to a valid DDS_DomainParticipant

Postcondition: Memory must be released by the user after finalizing DL.

RTIDLCDllExport RTIBool RTI_DL_Options_isRemoteAdministrationEnabled ( RTI_DL_Options * self )

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

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: true if the Remote Administration is enabled. Otherwise false.

RTIDLCDllExport void 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 parameter.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	enabled	Boolean indicating new remote administration value.

RTIDLCDllExport int RTI_DL_Options_getFilterLevel ( RTI_DL_Options * self )

Gets the log level.

The IDL file contains the pre-defined log filter levels such as RTI_DL_INFO_LEVEL. Please use one of these constants to set this field. It is possible to use other values but this is an advanced use case which is not fully supported at this time. The default value is RTI_DL_TRACE_LEVEL.

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: integer containing the log filter level value of the options.

RTIDLCDllExport void RTI_DL_Options_setFilterLevel	(	RTI_DL_Options *	self,
		int	filterLevel
	)

Sets the log level.

The IDL file contains the pre-defined log levels such as RTI_DL_INFO_LEVEL. Please use one of these constants to set this field. It is possible to use other values but this is an advanced use case which is not fully supported at this time.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	logLevel	Integer containing the log filter level value of the options.

RTIDLCDllExport int RTI_DL_Options_getDomainId ( RTI_DL_Options * self )

Gets the current domain id.

The DDS domain id to be used. This value is only used if domainParticipant is NULL. The default value is 0.

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: Integer containing the current DDS domain id.

RTIDLCDllExport void RTI_DL_Options_setDomainId	(	RTI_DL_Options *	self,
		int	domainId
	)

Sets the current domain id.

The DDS domain id to be used only if domainParticipant is NULL.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	domainId	Int representing a DDS domain id. Max value 250

RTIDLCDllExport char* RTI_DL_Options_getQosLibrary ( RTI_DL_Options * self )

Gets the Qos Library.

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 the Distributed Logger to use. The default value is "".

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: Pointer to a char containing the current Qos Library.

RTIDLCDllExport void RTI_DL_Options_setQosLibrary	(	RTI_DL_Options *	self,
		const char *	qosLibrary
	)

Sets the Qos Library.

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 the Distributed Logger to use.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	qosLibrary	Pointer to a char containing the new Qos Library.

RTIDLCDllExport char* RTI_DL_Options_getQosProfile ( RTI_DL_Options * self )

Gets the Qos Profile.

The QoS profile name to use when creating DDS entities. It is up to the application to ensure that this profile is available at runtime for the Distributed Logger to use. The default value is "".

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: Pointer to a char containing the current Qos Profile.

RTIDLCDllExport void RTI_DL_Options_setQosProfile	(	RTI_DL_Options *	self,
		const char *	qosProfile
	)

Sets the Qos Profile.

The QoS profile name to use when creating DDS entities. It is up to the application to ensure that this profile is available at runtime for the Distributed Logger to use.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	qosProfile	Pointer to a char containing the new Qos profile.

RTIDLCDllExport int RTI_DL_Options_getQueueSize ( RTI_DL_Options * self )

Gets the maximum queue size.

This field controls the size of the queue used to temporarily store log messages written from the application until they can be written out to DDS. The default value is RTI_DL_DEFAULT_QUEUE_SIZE.

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: Integer containing the current maximum queue size.

RTIDLCDllExport void RTI_DL_Options_setQueueSize	(	RTI_DL_Options *	self,
		int	queueSize
	)

Sets the maximum queue size.

This field controls the size of the queue used to temporarily store log messages written from the application until they can be written out to DDS.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct
[in]	queueSize	Integer containing the new maximum queue size.

RTIDLCDllExport struct DDS_ThreadSettings_t* RTI_DL_Options_getThreadSettings ( RTI_DL_Options * self )

read

Gets the thread settings of the publishing thread.

This fields controls the priority of the thread that sends the messages throw DDS. The default values are defined in dds_c_infrastructure.h.

Parameters

[in] self Pointer to a working RTI_DL_Options struct

Returns: The thread settings defined in the options.

RTIDLCDllExport void RTI_DL_Options_setThreadSettings	(	RTI_DL_Options *	self,
		const struct DDS_ThreadSettings_t *	threadSettings
	)

Sets the settings of the publishing thread.

This field controls the settings of the thread that sends the messages throw DDS.

Parameters

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

RTIDLCDllExport char* RTI_DL_Options_getApplicationKind ( RTI_DL_Options * self )

Gets the application kind.

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

Parameters

[in] self Pointer to a working RTI_DL_Options struct.

Returns: Pointer to a char containing the current application kind

RTIDLCDllExport void RTI_DL_Options_setApplicationKind	(	RTI_DL_Options *	self,
		const char *	applicationKind
	)

Sets the application kind.

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

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct.
[in]	applicationKind	Pointer to a string containing the new application kind

RTIDLCDllExport RTIBool RTI_DL_Options_getEchoToStdout ( RTI_DL_Options * self )

Gets the current value of echoToStdout.

If true, Distributed Logger prints the log messages received to the stdout. The default value is FALSE.

Parameters

[in] self Pointer to a working RTI_DL_Options struct.

Returns: Boolean to the current echoToStdout value

RTIDLCDllExport void RTI_DL_Options_setEchoToStdout	(	RTI_DL_Options *	self,
		RTIBool	echoToStdout
	)

Sets the value of echoToStdout.

If true, Distributed Logger prints the log messages received to the stdout. The default value is FALSE.

Parameters

[in,out]	self	Pointer to a working RTI_DL_Options struct.
[in]	echoToStdout	New value of set self.echoToStdout.

RTIDLCDllExport RTI_DL_Options* RTI_DL_Options_delete ( RTI_DL_Options * self )

Release memory for a RTI_DL_Options struct. Checks whether the pointer exists or not.

Parameters

[in] self Pointer to a working RTI_DL_Options struct. Checks whether the parameter is NULL or not

Returns: NULL if everything goes as planned.

Data Structures

Functions

Detailed Description

Function Documentation