|
sl@0
|
1 |
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// ULogger output plug-in interface
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@file
|
|
sl@0
|
20 |
@publishedPartner
|
|
sl@0
|
21 |
@prototype
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef ULOGGEROUTPUTPLUGIN_H
|
|
sl@0
|
25 |
#define ULOGGEROUTPUTPLUGIN_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#include <e32base.h>
|
|
sl@0
|
28 |
#include "uloggerplugin.h"
|
|
sl@0
|
29 |
#include "uloggerdatatypes.h"
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
namespace Ulogger
|
|
sl@0
|
32 |
{
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
//! Abstract class for ULogger output plug-ins.
|
|
sl@0
|
35 |
/*!
|
|
sl@0
|
36 |
A ULogger output plug-in is responsible for writing Trace log data to some
|
|
sl@0
|
37 |
output medium. Examples for output media are files, serial ports or TCP sockets.
|
|
sl@0
|
38 |
Whenever ULogger needs to output Trace log data, it passes this to the currently
|
|
sl@0
|
39 |
selected output plug-in, which then handles the actual writing to an output
|
|
sl@0
|
40 |
medium.
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
All output plug-ins must derive from this class in order to be compatible with
|
|
sl@0
|
43 |
ULogger. They must also derive from ULogger::CPlugin (whose header is already
|
|
sl@0
|
44 |
included by this header, for convenience) in order to be compatible with the
|
|
sl@0
|
45 |
ECom framework, which ULogger uses to load its output plug-ins.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
class MOutputPlugin
|
|
sl@0
|
48 |
{
|
|
sl@0
|
49 |
public:
|
|
sl@0
|
50 |
/**
|
|
sl@0
|
51 |
Writes the given data to the output media that is represented by the
|
|
sl@0
|
52 |
plug-in implementation. This method is called by ULogger whenever Trace log
|
|
sl@0
|
53 |
data becomes available. How much data is passed to this function depends
|
|
sl@0
|
54 |
on how ULogger is configured; the length of the given descriptor
|
|
sl@0
|
55 |
indicates the size of the data packet. The intervals at which
|
|
sl@0
|
56 |
this method is called depends on the amount of Trace data that is logged
|
|
sl@0
|
57 |
from code in the currently running processes.
|
|
sl@0
|
58 |
|
|
sl@0
|
59 |
@param aData the Trace data to output, in BTrace format
|
|
sl@0
|
60 |
@return KErrNone, if successful; otherwise one of the other system wide
|
|
sl@0
|
61 |
error codes.
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
virtual TInt Write(const TDesC8& aData) = 0;
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
/**
|
|
sl@0
|
66 |
Called by ULogger as first method after construction or after changes in
|
|
sl@0
|
67 |
config file. This allows the output plug-in to initialize itself with its
|
|
sl@0
|
68 |
private settings.
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
@param aConfigs actual configurations valid for this instance
|
|
sl@0
|
71 |
@return KErrNone, if successful; otherwise one of the other system wide
|
|
sl@0
|
72 |
error codes.
|
|
sl@0
|
73 |
*/
|
|
sl@0
|
74 |
virtual TInt ConfigureOutputPlugin(const RPointerArray<TPluginConfiguration>& aConfigs) = 0;
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
/**
|
|
sl@0
|
77 |
Called by ULogger to indicate that the output plug-in must flush all buffers
|
|
sl@0
|
78 |
and release any locked resources. Any resources may be locked only after any
|
|
sl@0
|
79 |
other method is called.
|
|
sl@0
|
80 |
*/
|
|
sl@0
|
81 |
virtual void CloseOutputPlugin() = 0;
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
/** Virtual destructor. */
|
|
sl@0
|
84 |
virtual ~MOutputPlugin(){}
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
/**
|
|
sl@0
|
87 |
Output plug-in interface id. This is for ULogger to distinguish between the
|
|
sl@0
|
88 |
different types of plug-ins (e.g. Output vs Input plug-ins).
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
static const CPlugin::TPluginInterface iInterfaceId = CPlugin::EOutput;
|
|
sl@0
|
91 |
};
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
} //end of namespace
|
|
sl@0
|
94 |
|
|
sl@0
|
95 |
#endif // ULOGGEROUTPUTPLUGIN_H
|