tracesrv/tracecore/btrace_handler/inc/TraceCoreNotifier.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
// Registers / unregisters notification receivers and send notifications 
hgs
parents:
diff changeset
    15
// to them when needed.
hgs
parents:
diff changeset
    16
// 
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef __TRACECORENOTIFIER_H__
hgs
parents:
diff changeset
    19
#define __TRACECORENOTIFIER_H__
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// Include files
hgs
parents:
diff changeset
    23
#include <kernel/kernel.h>
hgs
parents:
diff changeset
    24
#include <opensystemtrace_types.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// Forward declarations
hgs
parents:
diff changeset
    27
class MTraceCoreNotificationReceiver;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
 * Notification receiver item
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
NONSHARABLE_CLASS( TNotificationReceiverItem )
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
     * Component ID
hgs
parents:
diff changeset
    38
     */
hgs
parents:
diff changeset
    39
    TUint32 iComponentID;
hgs
parents:
diff changeset
    40
    
hgs
parents:
diff changeset
    41
    /**
hgs
parents:
diff changeset
    42
     * Group ID
hgs
parents:
diff changeset
    43
     */
hgs
parents:
diff changeset
    44
    TUint32 iGroupID;
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
    /**
hgs
parents:
diff changeset
    47
     * The notification receiver associated with the component id and group id
hgs
parents:
diff changeset
    48
     */
hgs
parents:
diff changeset
    49
    MTraceCoreNotificationReceiver* iReceiver;
hgs
parents:
diff changeset
    50
    };
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
/**
hgs
parents:
diff changeset
    54
 * Notification receiver receives subscriptions and delegates messages to them
hgs
parents:
diff changeset
    55
 */
hgs
parents:
diff changeset
    56
NONSHARABLE_CLASS( DTraceCoreNotifier ) : public DBase
hgs
parents:
diff changeset
    57
    {
hgs
parents:
diff changeset
    58
public:
hgs
parents:
diff changeset
    59
		
hgs
parents:
diff changeset
    60
    /**
hgs
parents:
diff changeset
    61
    * Constructor
hgs
parents:
diff changeset
    62
    */
hgs
parents:
diff changeset
    63
    DTraceCoreNotifier();
hgs
parents:
diff changeset
    64
    
hgs
parents:
diff changeset
    65
    /**
hgs
parents:
diff changeset
    66
    * Destructor
hgs
parents:
diff changeset
    67
    */
hgs
parents:
diff changeset
    68
    ~DTraceCoreNotifier();
hgs
parents:
diff changeset
    69
    
hgs
parents:
diff changeset
    70
    /**
hgs
parents:
diff changeset
    71
    * Register notification receiver
hgs
parents:
diff changeset
    72
    *
hgs
parents:
diff changeset
    73
    * @param aItem The properties of the notification receiver
hgs
parents:
diff changeset
    74
    */
hgs
parents:
diff changeset
    75
	TInt RegisterNotificationReceiver( TNotificationReceiverItem& aItem );
hgs
parents:
diff changeset
    76
	
hgs
parents:
diff changeset
    77
	/**
hgs
parents:
diff changeset
    78
	* Unregister notification receiver
hgs
parents:
diff changeset
    79
    *
hgs
parents:
diff changeset
    80
	* @param aItem The properties of the notification receiver
hgs
parents:
diff changeset
    81
	*/
hgs
parents:
diff changeset
    82
	void UnregisterNotificationReceiver( TNotificationReceiverItem& aItem );
hgs
parents:
diff changeset
    83
	
hgs
parents:
diff changeset
    84
	/**
hgs
parents:
diff changeset
    85
	* Unregister all traces of given notification receiver
hgs
parents:
diff changeset
    86
	*
hgs
parents:
diff changeset
    87
	* @param aNotificationReceiver The notification receiver to be unregistered
hgs
parents:
diff changeset
    88
	*/
hgs
parents:
diff changeset
    89
	void UnregisterNotificationReceiver( MTraceCoreNotificationReceiver& aNotificationReceiver );
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
	/**
hgs
parents:
diff changeset
    92
	* Get defined component's registered group IDs
hgs
parents:
diff changeset
    93
	*
hgs
parents:
diff changeset
    94
	* @param aComponentID The component id
hgs
parents:
diff changeset
    95
	* @param aGroupIDs Array for registered group IDs
hgs
parents:
diff changeset
    96
	*/
hgs
parents:
diff changeset
    97
	void GetComponentRegisteredGroupIDs( TUint32 aComponentID, RArray< TUint >& aGroupIDs );
hgs
parents:
diff changeset
    98
		
hgs
parents:
diff changeset
    99
	/**
hgs
parents:
diff changeset
   100
	* Callback when trace is activated
hgs
parents:
diff changeset
   101
	*
hgs
parents:
diff changeset
   102
	* @param aComponentID The component id
hgs
parents:
diff changeset
   103
	* @param aGroupId The group id 
hgs
parents:
diff changeset
   104
	*/
hgs
parents:
diff changeset
   105
    void TraceActivated( TUint32 aComponentId, TUint16 aGroupId );
hgs
parents:
diff changeset
   106
    
hgs
parents:
diff changeset
   107
    /**
hgs
parents:
diff changeset
   108
	* Callback when trace is deactivated
hgs
parents:
diff changeset
   109
	*
hgs
parents:
diff changeset
   110
	* @param aComponentID The component id
hgs
parents:
diff changeset
   111
	* @param aGroupId The group id 
hgs
parents:
diff changeset
   112
	*/
hgs
parents:
diff changeset
   113
    void TraceDeactivated( TUint32 aComponentId, TUint16 aGroupId );
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
    /**
hgs
parents:
diff changeset
   116
     * Callback when there is a trace error
hgs
parents:
diff changeset
   117
     * 
hgs
parents:
diff changeset
   118
     * @param aComponentId The component ID
hgs
parents:
diff changeset
   119
     * @param aGroupId The group ID    
hgs
parents:
diff changeset
   120
     * @param aError The reason for error
hgs
parents:
diff changeset
   121
     */
hgs
parents:
diff changeset
   122
    void TraceError( TUint32 aComponentId, TUint32 aGroupId, TInt aError  );
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
private:
hgs
parents:
diff changeset
   125
	
hgs
parents:
diff changeset
   126
    /**
hgs
parents:
diff changeset
   127
    * Active subscriptions
hgs
parents:
diff changeset
   128
    */
hgs
parents:
diff changeset
   129
	RArray< TNotificationReceiverItem > iNotificationReceiverItems;
hgs
parents:
diff changeset
   130
	
hgs
parents:
diff changeset
   131
    /**
hgs
parents:
diff changeset
   132
    * Notifies immediately if group was activated
hgs
parents:
diff changeset
   133
    *
hgs
parents:
diff changeset
   134
    * @param aComponentID The component id
hgs
parents:
diff changeset
   135
    * @param aGroupId The group id 
hgs
parents:
diff changeset
   136
    */
hgs
parents:
diff changeset
   137
    void NotifyImmediately( TUint32 aComponentId, TGroupId aGroupId );
hgs
parents:
diff changeset
   138
    
hgs
parents:
diff changeset
   139
    };
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
#endif
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
// End of File