package DDS.Logger is

(c) Copyright, Real-Time Innovations, 2025. All rights reserved. No duplications, whole or partial, manual or electronic, may be made without express written permission. Any such copies, or revisions thereof, must display this notice unaltered. This code contains trade secrets of Real-Time Innovations, Inc.

function Get_Instance return Ref_Access;

MT Safety:
UNSAFE. In VxWorks, it is unsafe to call this procedure while another thread may be simultaneously calling DDS.DomainParticipantFactory.get_instance, DDS.DomainParticipantFactory.finalize_instance, DDS_TypeCodeFactory.get_instance, DDSGuardCondition::DDSGuardCondition, DDSWaitSet::DDSWaitSet(), DDSWaitSet::DDSWaitSet(const DDS_WaitSetProperty_t&), DDSGuardCondition::~DDSGuardCondition, DDSWaitSet::~DDSWaitSet(), NDDSConfigLogger.get_instance, NDDSConfigLogger.get_output_device, NDDSConfigLogger.set_output_device, NDDSUtilityNetworkCapture.enable, or NDDSUtilityNetworkCapture.disable.

function Get_Verbosity 
(
This
: not null access Ref) return LogVerbosity;

The default verbosity if NDDSConfigLogger.set_verbosity is never called is NDDS_CONFIG_LOG_VERBOSITY_ERROR.

If NDDSConfigLogger.set_verbosity_by_category has been used to set different verbosities for different categories of messages, this procedure will return the maximum verbosity of all categories.

function Get_Verbosity 
(
This
:    not null access Ref;
Category
: in LogCategory) return LogVerbosity;

The default verbosity if NDDSConfigLogger.set_verbosity and NDDSConfigLogger.set_verbosity_by_category are never called is NDDS_CONFIG_LOG_VERBOSITY_ERROR.

procedure Set_Verbosity 
(
This
:    not null access Ref;
Verbosity
: in LogVerbosity);

Note: Logging at high verbosities will be detrimental to your application's performance. Your default setting should typically remain at NDDS_CONFIG_LOG_VERBOSITY_WARNING or below. (The default verbosity if you never set it is NDDS_CONFIG_LOG_VERBOSITY_ERROR.)

procedure Set_Verbosity 
(
This
:    not null access Ref;
Category
: in LogCategory;
Verbosity
: in LogVerbosity);

function Get_Print_Format 
(
This
: not null access Ref) return LogPrintFormat;

Use NDDSConfigLogger.get_print_format_by_log_level to retrieve the format for other log levels.

If NDDSConfigLogger.set_print_format is never called, the default format is NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

procedure Set_Print_Format 
(
This
: not null access Ref;
Format
: LogPrintFormat);

function Get_Output_File 
(
This
: not null access Ref) return Interfaces.C_Streams.FILEs;

Get the file to which the logged output is redirected. If no output file has been registered through set_output_file, this function will return NULL. In this case, logged output will on most platforms go to standard out.

procedure Set_Output_File 
(
This
: not null access Ref;
To
: Interfaces.C_Streams.FILEs);

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). For better performance when log messages are generated frequently, the log messages are not flushed into a file immediately after they are generated. In other words, while writing a log message, RTI Connext only calls the function fwrite() (see https://pubs.opengroup.org/onlinepubs/009695399/functions/fwrite.html); it does not call the function fflush() (see https://pubs.opengroup.org/onlinepubs/009695399/functions/fflush.html). If your application requires a different flushing behavior, you may use set_output_device to configure a custom logging device.

procedure Set_Output_File_Name 
(
This
: not null access Ref;
File_Name
: Standard.String);

Set the name of the file to which the logged output is redirected. The name may be NULL, in which case further logged output will be redirected to the platform-specific default output location (standard out on most platforms). See output_file for the flushing behavior.

procedure Set_Output_File_Set 
(
This
: not null access Ref;
File_Preffix
: Standard.String;
File_Suffix
: Standard.String;
Max_Capacity
: Natural;
Max_Files
: Natural);

Configure a set of files to redirect the logged output. The logged output will be redirected to a set of files whose names are configured with a prefix and a suffix. The maximum number of bytes configures how many bytes to write into a file before opening the next file. After reaching the maximum number of files, the first one is overwritten. For example, if the prefix is 'Foo', the suffix is '.txt', the max number of bytes is 1GB, and the max number of files is 3, the logger will create (at most) these files: Foo1.txt, Foo2.txt, and Foo3.txt. It will write to Foo1.txt, and after writing 1GB, it will move on to Foo2.txt, then to Foo3.txt, then to Foo1.txt again, and so on. To stop logging to these files and redirect the output to the platform-specific location, pass "", "", 0, 0.