bthci/bthci2/hctl/interface/hctlchannelobserver.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 HCTLCHANNELOBSERVER_H
       
    23 #define HCTLCHANNELOBSERVER_H
       
    24 
       
    25 #include <e32base.h>
       
    26 
       
    27 /** Definition of the HCI transport channel type */
       
    28 typedef TUint16 THCITransportChannel;	
       
    29 
       
    30 /** No HCI transport channels available for sending */
       
    31 static const THCITransportChannel KHCITransportNoChannels		= 0x0000;
       
    32 
       
    33 /** Command HCI transport channel available for sending */
       
    34 static const THCITransportChannel KHCITransportCommandChannel	= 0x0001;
       
    35 
       
    36 /** ACL data HCI transport channel available for sending */
       
    37 static const THCITransportChannel KHCITransportACLDataChannel	= 0x0002;
       
    38 
       
    39 /** SCO data HCI transport channel available for sending */
       
    40 static const THCITransportChannel KHCITransportSCODataChannel	= 0x0004;
       
    41 
       
    42 /** All HCI transport channels available for sending */
       
    43 static const THCITransportChannel KHCITransportAllChannels = static_cast<THCITransportChannel>(KHCITransportCommandChannel | 
       
    44 																							   KHCITransportACLDataChannel | 
       
    45 																							   KHCITransportSCODataChannel);
       
    46 
       
    47 /** The UID associated with the MHCTLChannelObserver interface. */
       
    48 const TInt KHCTLChannelObserverUid = 0x102736EF;
       
    49 
       
    50 /**
       
    51 API for observing information regarding the status of a HCTL channel.
       
    52 
       
    53 This should be implemented by the stack so it can control the multiplexing
       
    54 of the command and data sent over the HCTL.
       
    55 */
       
    56 class MHCTLChannelObserver
       
    57 	{
       
    58 public:
       
    59 	/**
       
    60 	Indication that a HCTL channel has been opened.
       
    61 
       
    62 	@param aChannel A bitmask containing the channels which are now open.
       
    63 	*/
       
    64 	virtual void MhcoChannelOpen(THCITransportChannel aChannels) =0;
       
    65 
       
    66 	/**
       
    67 	Indication that a HCTL channel has been closed.
       
    68 
       
    69 	@param aChannel A bitmask containing the channels which are now closed.
       
    70 	*/
       
    71 	virtual void MhcoChannelClosed(THCITransportChannel aChannels) =0;
       
    72 	};
       
    73 
       
    74 #endif // HCTLCHANNELOBSERVER_H