epoc32/include/bluetooth/hci/hctlchannelobserver.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
 @publishedPartner
williamr@2
    21
*/
williamr@2
    22
williamr@2
    23
#ifndef HCTLCHANNELOBSERVER_H
williamr@2
    24
#define HCTLCHANNELOBSERVER_H
williamr@2
    25
williamr@2
    26
/** Definition of the HCI transport channel type */
williamr@2
    27
typedef TUint16 THCITransportChannel;	
williamr@2
    28
williamr@2
    29
/** No HCI transport channels available for sending */
williamr@2
    30
static const THCITransportChannel KHCITransportNoChannels		= 0x0000;
williamr@2
    31
williamr@2
    32
/** Command HCI transport channel available for sending */
williamr@2
    33
static const THCITransportChannel KHCITransportCommandChannel	= 0x0001;
williamr@2
    34
williamr@2
    35
/** ACL data HCI transport channel available for sending */
williamr@2
    36
static const THCITransportChannel KHCITransportACLDataChannel	= 0x0002;
williamr@2
    37
williamr@2
    38
/** SCO data HCI transport channel available for sending */
williamr@2
    39
static const THCITransportChannel KHCITransportSCODataChannel	= 0x0004;
williamr@2
    40
williamr@2
    41
/** All HCI transport channels available for sending */
williamr@2
    42
static const THCITransportChannel KHCITransportAllChannels = static_cast<THCITransportChannel>(KHCITransportCommandChannel | 
williamr@2
    43
																							   KHCITransportACLDataChannel | 
williamr@2
    44
																							   KHCITransportSCODataChannel);
williamr@2
    45
williamr@2
    46
/** The UID associated with the MHCTLChannelObserver interface. */
williamr@2
    47
const TInt KHCTLChannelObserverUid = 0x102736EF;
williamr@2
    48
williamr@2
    49
/**
williamr@2
    50
API for observing information regarding the status of a HCTL channel.
williamr@2
    51
williamr@2
    52
This should be implemented by the stack so it can control the multiplexing
williamr@2
    53
of the command and data sent over the HCTL.
williamr@2
    54
*/
williamr@2
    55
class MHCTLChannelObserver
williamr@2
    56
	{
williamr@2
    57
public:
williamr@2
    58
	/**
williamr@2
    59
	Indication that a HCTL channel has been opened.
williamr@2
    60
williamr@2
    61
	@param aChannel A bitmask containing the channels which are now open.
williamr@2
    62
	*/
williamr@2
    63
	virtual void MhcoChannelOpen(THCITransportChannel aChannels) =0;
williamr@2
    64
williamr@2
    65
	/**
williamr@2
    66
	Indication that a HCTL channel has been closed.
williamr@2
    67
williamr@2
    68
	@param aChannel A bitmask containing the channels which are now closed.
williamr@2
    69
	*/
williamr@2
    70
	virtual void MhcoChannelClosed(THCITransportChannel aChannels) =0;
williamr@2
    71
	};
williamr@2
    72
williamr@2
    73
#endif // HCTLCHANNELOBSERVER_H