Collapse all Symbian^3 Application Developer Library

Ulogger::MOutputPlugin Class Reference

class Ulogger::MOutputPlugin

A ULogger output plug-in is responsible for writing Trace log data to some output medium. Examples for output media are files, serial ports or TCP sockets. Whenever ULogger needs to output Trace log data, it passes this to the currently selected output plug-in, which then handles the actual writing to an output medium.

All output plug-ins must derive from this class in order to be compatible with ULogger. They must also derive from ULogger::CPlugin (whose header is already included by this header, for convenience) in order to be compatible with the ECom framework, which ULogger uses to load its output plug-ins.

Public Member Functions
	~MOutputPlugin ()
void	CloseOutputPlugin ()
TInt	ConfigureOutputPlugin (const RPointerArray < TPluginConfiguration > &)
TInt	Write (const TDesC8 &)

Public Attributes
const CPlugin::TPluginInterface	iInterfaceId

Constructor & Destructor Documentation

~MOutputPlugin()

~MOutputPlugin

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

CloseOutputPlugin()

void

CloseOutputPlugin

(

)

[pure virtual]

Called by ULogger to indicate that the output plug-in must flush all buffers and release any locked resources. Any resources may be locked only after any other method is called.

ConfigureOutputPlugin(const RPointerArray< TPluginConfiguration > &)

TInt

ConfigureOutputPlugin

(

const RPointerArray < TPluginConfiguration > &

aConfigs

)

[pure virtual]

Called by ULogger as first method after construction or after changes in config file. This allows the output plug-in to initialize itself with its private settings.

Parameters

const RPointerArray < TPluginConfiguration > & aConfigs

actual configurations valid for this instance

Write(const TDesC8 &)

TInt

Write

(

const TDesC8 &

aData

)

[pure virtual]

Writes the given data to the output media that is represented by the plug-in implementation. This method is called by ULogger whenever Trace log data becomes available. How much data is passed to this function depends on how ULogger is configured; the length of the given descriptor indicates the size of the data packet. The intervals at which this method is called depends on the amount of Trace data that is logged from code in the currently running processes.

Parameters

const TDesC8 & aData

the Trace data to output, in BTrace format

Member Data Documentation

const CPlugin::TPluginInterface iInterfaceId

const CPlugin::TPluginInterface

iInterfaceId

[static]

Output plug-in interface id. This is for ULogger to distinguish between the different types of plug-ins (e.g. Output vs Input plug-ins).