The logger instance will route all log events it receives to the System.printf function.

Events written to a disabled log are silently discarded.

The function returns the state of the log (TRUE if enabled, FALSE if disabled) before the call. This return value allows clients to restore the previous state. Note: not thread safe.

The function returns the state of the log (TRUE if enabled, FALSE if disabled) before the call. This return value allows clients to restore the previous state. Note: not thread safe.

Same as write4 except with 0 arguments rather than 4.

Same as write4 except with 1 arguments rather than 4.

Same as write4 except with 2 arguments rather than 4.

The evt argument is of type Log.Event, which encodes the Log.EventId, the Diags.Mask, and the Diags.EventLevel of the event. The event ID can be obtained via Types.getEventId(evt), the Diags mask can be obtained via Diags.getMask(evt), and the event level can be obtained via Diags.getLevel(evt).

The modId argument is the module ID of the module that logged the event.

The event information can be used by the logger to handle different events specially. For example, the event ID can be used to compare against other known Log.Events.

      if (Log_getEventId(MY_EVENT) == Log_getEventId(evt)) {
          :
      }

The Diags mask and event level can be used for filtering of events based on event level (see IFilterLogger), or even routing events to separate loggers based on diags category (see, for example, LoggerBuf.statusLogger).

The Diags mask and event level are useful for handling the event, but are generally not recorded by the logger because they are not needed in decoding and displaying the event. A more suitable value to record is a Types.Event, which encodes the event ID and module ID. For example, the Log.EventRec type stores a Types.Event in its record definition. A Types.Event can be created using the Types.makeEvent API given the event ID and module ID.

The event ID value of 0 is used to indicate an event triggered by a call to one of the Log_print[0-6] methods. These methods take a format string rather than a Log_Event argument and, as a result, the event ID encoded in evt is 0 and the parameter a1 is the format string.

Non-zero event IDs can also be used to access the msg string associated with the Log.EventDesc that originally defined the Log event.

      Log_EventId id = Log_getEventId(evt));
      if (id != 0) {
          String msg = Text_ropeText(id);
          System_aprintf(msg, a1, a2, a3, a4);
      }

This works because an event's ID is simply an offset into a table of characters (maintained by the Text module) containing the event's msg string.

The arguments a1, a2, etc. are parameters that are to be interpreted according to the message format string associated with evt.

Log.Event, Log.EventDesc, Text.ropeText, Log.getEventId

Same as write4 except with 8 arguments rather than 4.

This proxy allows LoggerUart to use a timestamp server different from the server used by xdc.runtime.Timestamp. However, if not supplied by a user, this proxy defaults to whichever timestamp server is used by Timestamp.

All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.

This meta data should be returned in the form of a structure which can be converted into XML. This data is added to the RTA XML file during the application's configuration, and can be accessed later through the xdc.rta.MetaData module.

The MetaData is returned per instance of the ILogger module. The instance object is passed to the function as the first argument.

The second argument is the index of the instance in the list of the ILogger's static instances.

The logger instance will route all log events it receives to the System.printf function.