tracesrv/tracecore/btrace_handler/inc/TraceCoreHandler.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
// Base class for trace core handlers.
hgs
parents:
diff changeset
    15
//
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef __TRACECOREHANDLER_H__
hgs
parents:
diff changeset
    18
#define __TRACECOREHANDLER_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
hgs
parents:
diff changeset
    25
// Forward declarations
hgs
parents:
diff changeset
    26
class DTraceCoreSettings;
hgs
parents:
diff changeset
    27
class DTraceCoreWriter;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
 * Base class for trace core handlers. A handler receives trace data and delegates it to writer
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
NONSHARABLE_CLASS( DTraceCoreHandler ) : public DBase
hgs
parents:
diff changeset
    34
    {
hgs
parents:
diff changeset
    35
public:
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
    /**
hgs
parents:
diff changeset
    38
     * Constructor
hgs
parents:
diff changeset
    39
     */
hgs
parents:
diff changeset
    40
    DTraceCoreHandler();
hgs
parents:
diff changeset
    41
    
hgs
parents:
diff changeset
    42
    /**
hgs
parents:
diff changeset
    43
     * Destructor
hgs
parents:
diff changeset
    44
     */
hgs
parents:
diff changeset
    45
    ~DTraceCoreHandler();
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
    /**
hgs
parents:
diff changeset
    48
     * Registers this handler to trace core.
hgs
parents:
diff changeset
    49
     */
hgs
parents:
diff changeset
    50
    TInt Register();
hgs
parents:
diff changeset
    51
    
hgs
parents:
diff changeset
    52
    /**
hgs
parents:
diff changeset
    53
     * Called before SetWriter with interrupts enabled
hgs
parents:
diff changeset
    54
     *
hgs
parents:
diff changeset
    55
     * @param aWriter The new writer
hgs
parents:
diff changeset
    56
     */
hgs
parents:
diff changeset
    57
    virtual void PrepareSetWriter( DTraceCoreWriter* aWriter );
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
    /**
hgs
parents:
diff changeset
    60
     * Sets the active writer. This is called with interrupts disabled
hgs
parents:
diff changeset
    61
     *
hgs
parents:
diff changeset
    62
     * @param aWriter The new writer
hgs
parents:
diff changeset
    63
     */
hgs
parents:
diff changeset
    64
    virtual void SetWriter( DTraceCoreWriter* aWriter );
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
	/**
hgs
parents:
diff changeset
    67
     * Sets the settings (saver). Called by trace core
hgs
parents:
diff changeset
    68
     *
hgs
parents:
diff changeset
    69
     * @param aSettings The new settings
hgs
parents:
diff changeset
    70
     */
hgs
parents:
diff changeset
    71
    virtual void SetSettings( DTraceCoreSettings* aSettings );
hgs
parents:
diff changeset
    72
    
hgs
parents:
diff changeset
    73
private:
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    /**
hgs
parents:
diff changeset
    76
     * Unregisters this handler from trace core. Called from destructor
hgs
parents:
diff changeset
    77
     */
hgs
parents:
diff changeset
    78
    void Unregister();
hgs
parents:
diff changeset
    79
    
hgs
parents:
diff changeset
    80
protected:
hgs
parents:
diff changeset
    81
    
hgs
parents:
diff changeset
    82
    /**
hgs
parents:
diff changeset
    83
     * Writer interface
hgs
parents:
diff changeset
    84
     */
hgs
parents:
diff changeset
    85
 	DTraceCoreWriter* iWriter;
hgs
parents:
diff changeset
    86
 	
hgs
parents:
diff changeset
    87
 	/**
hgs
parents:
diff changeset
    88
     * Settings interface
hgs
parents:
diff changeset
    89
     */
hgs
parents:
diff changeset
    90
 	DTraceCoreSettings* iSettings;
hgs
parents:
diff changeset
    91
 	
hgs
parents:
diff changeset
    92
};
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
#endif
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
// End of File