tracesrv/tracecore/btrace_handler/inc/TraceCoreMediaPlugin.h
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
// Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
// Interface class for media plug-ins
hgs
parents:
diff changeset
    15
//
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef __TRACECOREMEDIAPLUGIN_H__
hgs
parents:
diff changeset
    18
#define __TRACECOREMEDIAPLUGIN_H__
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// Include files
hgs
parents:
diff changeset
    22
#include <kernel/kernel.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// Forward declarations
hgs
parents:
diff changeset
    25
class DTraceCorePluginIf;
hgs
parents:
diff changeset
    26
class TTraceMessage;
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
 * Media plug-in base class
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
class DTraceCoreMediaPlugin : public DBase
hgs
parents:
diff changeset
    33
    {
hgs
parents:
diff changeset
    34
public:
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
    /**
hgs
parents:
diff changeset
    37
     * Constructor
hgs
parents:
diff changeset
    38
     */
hgs
parents:
diff changeset
    39
    IMPORT_C DTraceCoreMediaPlugin();
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
    /**
hgs
parents:
diff changeset
    42
     * Destructor
hgs
parents:
diff changeset
    43
     */
hgs
parents:
diff changeset
    44
    IMPORT_C ~DTraceCoreMediaPlugin();
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
    /**
hgs
parents:
diff changeset
    47
     * Registers this plug-in to TraceCore
hgs
parents:
diff changeset
    48
     */
hgs
parents:
diff changeset
    49
    IMPORT_C TInt Register();
hgs
parents:
diff changeset
    50
    
hgs
parents:
diff changeset
    51
    /**
hgs
parents:
diff changeset
    52
     * Called by the plug-in to send an incoming message to TraceCore
hgs
parents:
diff changeset
    53
     * 
hgs
parents:
diff changeset
    54
     * @param aMsg The message that was received
hgs
parents:
diff changeset
    55
     */
hgs
parents:
diff changeset
    56
    IMPORT_C void MessageReceived( TTraceMessage &aMsg );
hgs
parents:
diff changeset
    57
    
hgs
parents:
diff changeset
    58
    /**
hgs
parents:
diff changeset
    59
     * Merges the header and data into a single buffer
hgs
parents:
diff changeset
    60
     * 
hgs
parents:
diff changeset
    61
     * @param aMsg Message to be sent.
hgs
parents:
diff changeset
    62
     * @param aMsgBlock The message block where data is merged
hgs
parents:
diff changeset
    63
     * @return KErrNone if successful
hgs
parents:
diff changeset
    64
     */
hgs
parents:
diff changeset
    65
    IMPORT_C TInt MergeHeaderAndData( const TTraceMessage& aMsg, TDes8& aTarget );
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
    /**
hgs
parents:
diff changeset
    68
     * Called by TraceCore to send a message out
hgs
parents:
diff changeset
    69
     * 
hgs
parents:
diff changeset
    70
     * @param aMsg The message to be sent
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    virtual TInt SendMessage( TTraceMessage &aMsg ) = 0;
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
private:
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
    /**
hgs
parents:
diff changeset
    77
     * Unregisters this plug-in from TraceCore. Called from destructor
hgs
parents:
diff changeset
    78
     */
hgs
parents:
diff changeset
    79
    void Unregister();
hgs
parents:
diff changeset
    80
    };
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
#endif // __TRACECOREMEDIAPLUGIN_H__
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
// End of File