|
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 input 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 ULOGGERINPUTPLUGIN_H
|
|
sl@0
|
25 |
#define ULOGGERINPUTPLUGIN_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 input plug-ins.
|
|
sl@0
|
35 |
/*!
|
|
sl@0
|
36 |
A ULogger input plug-in listens for ULogger commands on some communication
|
|
sl@0
|
37 |
medium, such as serial, usb or a TCP socket. Whenever a command is received
|
|
sl@0
|
38 |
by the input plug-in, it passes this command to ULogger, which then interprets
|
|
sl@0
|
39 |
the command, acts on it, and returns a response to the input plug-in. The input
|
|
sl@0
|
40 |
plug-in sends any response coming from ULogger back to the client that sent
|
|
sl@0
|
41 |
the command in the first place.
|
|
sl@0
|
42 |
|
|
sl@0
|
43 |
All input plug-ins must derive from this class in order to be compatible with
|
|
sl@0
|
44 |
ULogger. They must also derive from ULogger::CPlugin (whose header is already
|
|
sl@0
|
45 |
included by this header, for convenience) in order to be compatible with the
|
|
sl@0
|
46 |
ECom framework, which ULogger uses to load its input plug-ins.
|
|
sl@0
|
47 |
*/
|
|
sl@0
|
48 |
class MInputPlugin
|
|
sl@0
|
49 |
{
|
|
sl@0
|
50 |
public:
|
|
sl@0
|
51 |
/**
|
|
sl@0
|
52 |
Asynchronous method that reads command data from the input medium. ULogger
|
|
sl@0
|
53 |
calls this when it's ready to receive command data from the input plug-in.
|
|
sl@0
|
54 |
When the input plug-in completes the read operation it notifies the caller
|
|
sl@0
|
55 |
via the TRequestStatus that is passed into this method by reference. It
|
|
sl@0
|
56 |
provides the command data that has been received in the descriptor that is
|
|
sl@0
|
57 |
passed into this method by reference.
|
|
sl@0
|
58 |
Input plug-ins typically implement this method by simply passing the
|
|
sl@0
|
59 |
TRequestStatus and descriptor arguments on to another asynchronous method,
|
|
sl@0
|
60 |
such as for example a socket's ReadOneOrMore method.
|
|
sl@0
|
61 |
|
|
sl@0
|
62 |
@param aStatus The request status used to contain completion information for
|
|
sl@0
|
63 |
the function. On completion, contains a system-wide error
|
|
sl@0
|
64 |
code.
|
|
sl@0
|
65 |
@param aData A descriptor reference to store data obtained from input
|
|
sl@0
|
66 |
channel.
|
|
sl@0
|
67 |
@return KErrNone if operation was finished without any problems, system wide
|
|
sl@0
|
68 |
error code otherwise.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
virtual TInt ReadData(TRequestStatus& aStatus, TDes8& aData) = 0;
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/** Cancels asynchronous operation issued by ReadData method. */
|
|
sl@0
|
73 |
virtual void CancelReadData() = 0;
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
/**
|
|
sl@0
|
76 |
Synchronous Method that sends the given acknowledgment data back to the
|
|
sl@0
|
77 |
client that is sending command data to the input plug-in. ULogger calls this
|
|
sl@0
|
78 |
method whenever it needs to send a response to a previously received
|
|
sl@0
|
79 |
command.
|
|
sl@0
|
80 |
|
|
sl@0
|
81 |
@param aData A descriptor which contains error code or other results, for
|
|
sl@0
|
82 |
example, array of filters.
|
|
sl@0
|
83 |
Format of this data depends on previously obtained command.
|
|
sl@0
|
84 |
@return KErrNone is send operation finished with success otherwise
|
|
sl@0
|
85 |
system wide error code.
|
|
sl@0
|
86 |
*/
|
|
sl@0
|
87 |
virtual TInt SendAcknowledgment(const TDesC8& aData) = 0;
|
|
sl@0
|
88 |
|
|
sl@0
|
89 |
/**
|
|
sl@0
|
90 |
Called by ULogger as first method after construction or after changes in
|
|
sl@0
|
91 |
config file. This allows the input plug-in to initialize itself with its
|
|
sl@0
|
92 |
private settings.
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
@param aConfigs actual configurations valid for this instance
|
|
sl@0
|
95 |
@return KErrNone, if successful; otherwise one of the other system wide
|
|
sl@0
|
96 |
error codes.
|
|
sl@0
|
97 |
*/
|
|
sl@0
|
98 |
virtual TInt ConfigureInputPlugin(const RPointerArray<TPluginConfiguration>& aConfigs) = 0;
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
/**
|
|
sl@0
|
101 |
Called by ULogger to indicate that the input plug-in must flush all buffers
|
|
sl@0
|
102 |
and release any locked resources. Any resources may be locked only after any
|
|
sl@0
|
103 |
other method is called.
|
|
sl@0
|
104 |
*/
|
|
sl@0
|
105 |
virtual void CloseInputPlugin() = 0;
|
|
sl@0
|
106 |
|
|
sl@0
|
107 |
/** Virtual destructor. */
|
|
sl@0
|
108 |
virtual ~MInputPlugin(){}
|
|
sl@0
|
109 |
|
|
sl@0
|
110 |
/**
|
|
sl@0
|
111 |
Input plug-in interface id. This is for ULogger to distinguish between the
|
|
sl@0
|
112 |
different types of plug-ins (e.g. Intput vs Output plug-ins).
|
|
sl@0
|
113 |
*/
|
|
sl@0
|
114 |
static const CPlugin::TPluginInterface iInterfaceId = CPlugin::EInput;
|
|
sl@0
|
115 |
};
|
|
sl@0
|
116 |
|
|
sl@0
|
117 |
} //end of namespace
|
|
sl@0
|
118 |
|
|
sl@0
|
119 |
#endif /* ULOGGERINPUTPLUGIN_H */
|