bthci/bthci2/hctl/interface/controllerstateobserver.h
changeset 0 29b1cd4cb562
equal deleted inserted replaced
-1:000000000000 0:29b1cd4cb562
       
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @publishedPartner
       
    19  @released
       
    20 */
       
    21 
       
    22 #ifndef CONTROLLERSTATEOBSERVER_H
       
    23 #define CONTROLLERSTATEOBSERVER_H
       
    24 
       
    25 #include <bluetooth/hci/hcitypes.h>
       
    26 
       
    27 /**
       
    28 Interface for receiving controller state change events.
       
    29 Power state and reset events.
       
    30 */
       
    31 class MControllerStateObserver
       
    32 	{
       
    33 public:
       
    34 	enum TControllerChangeType
       
    35 		/**
       
    36 		This is primarily to inform the stack what it needs to do. 
       
    37 		May also be used elsewhere within the HCI framework if required.
       
    38 		*/
       
    39 		{
       
    40 		EBTNonFatalChange, /*!< No state changes in layers above required as a result of function call. */
       
    41 		EBTFatalChange, /*!< State changes may be required in layers above required as a result of function call. */
       
    42 		};
       
    43 
       
    44 
       
    45 	/**
       
    46 	Called to signal that a change in power state has occurred.
       
    47 	@param aError Any error condition that has occurred.
       
    48 	@param aChangeType The impact on the receiver of the call.
       
    49 	@param aState The new power state (that has just been entered).
       
    50 	*/
       
    51 	virtual void McsoProcessPowerChange(TInt aError, TControllerChangeType aChangeType, TBTPowerState aState) = 0;
       
    52 
       
    53 	/**
       
    54 	Called to signal that the hard reset process has reached a new state.
       
    55 	
       
    56 	@param aError Any error condition that has occurred.
       
    57 	@param aChangeType The impact on the receiver of the call.
       
    58 	@param aState The new hard reset state (that has just been entered).
       
    59 	*/
       
    60 	virtual void McsoProcessHardResetPhaseChange(TInt aError, TControllerChangeType aChangeType, TBTHardResetState aState) = 0;
       
    61 	};
       
    62 
       
    63 #endif // CONTROLLERSTATEOBSERVER_H