module xdcruntime.cstubs.LoggerFlex
C synopsis target-domain sourced in xdcruntime/cstubs/LoggerFlex.xdc
#include <xdcruntime/cstubs/LoggerFlex.h>
Functions
Void
Void 
Functions common to all ILogger modules
Bool 
Bool 
Void 
Void 
Void 
Void 
Void 
LoggerFlex_write8// Process a log event with up to 8 arguments(LoggerFlex_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4, IArg a5, IArg a6, IArg a7, IArg a8);
Functions common to all target instances
Functions common to all target modules
Typedefs
typedef struct
typedef struct
typedef struct
Constants
extern const Error_Id 
 
config LoggerFlex_E_atexit  // module-wide
C synopsis target-domain
extern const Error_Id LoggerFlex_E_atexit;
LoggerFlex_shutdown()  // module-wide

Shut down LoggerFlex module and free any resources used

C synopsis target-domain
Void LoggerFlex_shutdown(Int status);
DETAILS
This function will call ILoggerFlex_exit()
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId LoggerFlex_Module_id();
// Get this module's unique id
 
Bool LoggerFlex_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle LoggerFlex_Module_heap();
// The heap from which this module allocates memory
 
Bool LoggerFlex_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 LoggerFlex_Module_getMask();
// Returns the diagnostics mask for this module
 
Void LoggerFlex_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct LoggerFlex_Object LoggerFlex_Object;
// Opaque internal representation of an instance object
 
typedef LoggerFlex_Object *LoggerFlex_Handle;
// Client reference to an instance object
 
typedef struct LoggerFlex_Struct LoggerFlex_Struct;
// Opaque client structure large enough to hold an instance object
 
LoggerFlex_Handle LoggerFlex_handle(LoggerFlex_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
LoggerFlex_Struct *LoggerFlex_struct(LoggerFlex_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct LoggerFlex_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} LoggerFlex_Params;
 
Void LoggerFlex_Params_init(LoggerFlex_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
LoggerFlex_disable()  // instance

Disable a log

C synopsis target-domain
Bool LoggerFlex_disable(LoggerFlex_Handle handle);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
DETAILS
Events written to a disabled log are silently discarded.
RETURNS
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.
LoggerFlex_enable()  // instance

Enable a log

C synopsis target-domain
Bool LoggerFlex_enable(LoggerFlex_Handle handle);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
RETURNS
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.
LoggerFlex_write0()  // instance

Process a log event with 0 arguments

C synopsis target-domain
Void LoggerFlex_write0(LoggerFlex_Handle handle, Log_Event evt, Types_ModuleId mid);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
DETAILS
Same as write4 except with 0 arguments rather than 4.
SEE
LoggerFlex_write1()  // instance

Process a log event with 1 arguments

C synopsis target-domain
Void LoggerFlex_write1(LoggerFlex_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
DETAILS
Same as write4 except with 1 arguments rather than 4.
SEE
LoggerFlex_write2()  // instance

Process a log event with 2 arguments

C synopsis target-domain
Void LoggerFlex_write2(LoggerFlex_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
DETAILS
Same as write4 except with 2 arguments rather than 4.
SEE
LoggerFlex_write4()  // instance

Process a log event with up to 4 arguments

C synopsis target-domain
Void LoggerFlex_write4(LoggerFlex_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
evt — event to be logged
mid — module ID of the module which logged the event
a1 — arbitrary argument passed by caller
DETAILS
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.
SEE
LoggerFlex_write8()  // instance

Process a log event with up to 8 arguments

C synopsis target-domain
Void LoggerFlex_write8(LoggerFlex_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4, IArg a5, IArg a6, IArg a7, IArg a8);
ARGUMENTS
handle — handle of a previously-created LoggerFlex instance object
DETAILS
Same as write4 except with 8 arguments rather than 4.
SEE
Instance Convertors

C synopsis target-domain
ILogger_Handle LoggerFlex_Handle_upCast(LoggerFlex_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
LoggerFlex_Handle LoggerFlex_Handle_downCast(ILogger_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int LoggerFlex_Object_count();
// The number of statically-created instance objects
 
LoggerFlex_Handle LoggerFlex_Object_get(LoggerFlex_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
LoggerFlex_Handle LoggerFlex_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
LoggerFlex_Handle LoggerFlex_Object_next(LoggerFlex_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle LoggerFlex_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *LoggerFlex_Handle_label(LoggerFlex_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String LoggerFlex_Handle_name(LoggerFlex_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in xdcruntime/cstubs/LoggerFlex.xdc
var LoggerFlex = xdc.useModule('xdcruntime.cstubs.LoggerFlex');
module-wide config parameters
        msg: "E_atexit: Could not plug in atexit function for shutdown"
    };
module-wide functions
per-instance config parameters
    var params = new LoggerFlex.Params// Instance config-params object;
 
config LoggerFlex.E_atexit  // module-wide
XDCscript usage meta-domain
LoggerFlex.E_atexit = Error.Desc {
    msg: "E_atexit: Could not plug in atexit function for shutdown"
};
C SYNOPSIS
metaonly config LoggerFlex.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
LoggerFlex.common$ = Types.Common$ undefined;
DETAILS
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.
metaonly LoggerFlex.getMetaArgs()  // module-wide

Returns any meta data needed to support RTA

XDCscript usage meta-domain
LoggerFlex.getMetaArgs(Any inst, Any instNum) returns Any
DETAILS
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.
Instance Config Parameters

XDCscript usage meta-domain
var params = new LoggerFlex.Params;
// Instance config-params object
generated on Fri, 29 Oct 2010 00:26:50 GMT