examples/sfexamples/RockPaperScissorsGameSourceCode_S60/RPS/inc/BluetoothDeviceDiscoverer.h

00001 /*
00002 Copyright (c) 2002-2011 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
00003 
00004 Redistribution and use in source and binary forms, with or without
00005 modification, are permitted provided that the following conditions are met:
00006 
00007 * Redistributions of source code must retain the above copyright notice, this
00008   list of conditions and the following disclaimer.
00009 * Redistributions in binary form must reproduce the above copyright notice,
00010   this list of conditions and the following disclaimer in the documentation
00011   and/or other materials provided with the distribution.
00012 * Neither the name of Nokia Corporation nor the names of its contributors
00013   may be used to endorse or promote products derived from this software
00014   without specific prior written permission.
00015 
00016 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00017 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00018 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00020 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00021 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00022 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00023 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00024 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00025 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026 
00027 Description:  CBluetoothDeviceDiscoverer is responsible for displaying to the player (Master role) the available
00028                 BT devices in range from which they can choose. CBluetoothDeviceDiscoverer is implemented using the
00029                 Rnotifier dialog that is provided by the Notifier Framework. If the application needs to customize the 
00030                 BT discovery [by displaying to the user the BT devices in range using a custumize UI] then the
00031                 application needs to use the RHostResolver class instead of the RNotifier class. Steps to use
00032                 the RHostResolver are:
00033  
00034                 1) RHostResolver::Open(RSocketServ &aSocketServer, TUint anAddrFamily, TUint aProtocol);
00035                 2) RHostResolver::GetByAddress(const TSockAddr &anAddr, TNameEntry &aResult, TRequestStatus &aStatus);
00036                 3) In the RunL store the BT address and call RHostResolver::Next() to get the next availble BT device.
00037                 4) When the BT discovery is finished then pass the array of BT device addresses to the engine (by a callbck)
00038                    to be displayed by the customized UI (like a multi choice control).
00039                 5) The Master player selects the BT devices to which she wants to connect.
00040                 6)The App engine will create one Connector per BT device selected by the Master player
00041  
00042 */
00043 
00044 
00045 #ifndef __BLUETOOTHDEVICEDISCOVERER_H__
00046 #define __BLUETOOTHDEVICEDISCOVERER_H__
00047 
00048 #include <bt_sock.h>
00049 #include <btmanclient.h>
00050 #include <btsdp.h>
00051 #include "commoninterfaces.h"
00052 
00057 class CBluetoothDeviceDiscoverer : public CActive
00058     {
00059 public:
00064     static CBluetoothDeviceDiscoverer* NewL(MBluetoothDeviceDiscovererObserver& aObs);
00065     
00069     ~CBluetoothDeviceDiscoverer();
00070     
00075     void DiscoverAndSelectDeviceL(const TBTDeviceSelectionParamsPckg& aSelectionFilter);
00076 private:
00081     CBluetoothDeviceDiscoverer(MBluetoothDeviceDiscovererObserver& aObs);
00082     
00086     void ConstructL();
00087   
00088     //From CActive
00092     void RunL();
00093     
00097     void DoCancel();
00098     
00106         virtual TInt RunError(TInt aError);
00107 private:
00111         MBluetoothDeviceDiscovererObserver& iObserver;
00112         
00116         RNotifier iBTDevicesNotifier;
00117         
00121         TBTDeviceResponseParamsPckg iResponse;
00122     };
00123 
00124 #endif // __BLUETOOTHDEVICEDISCOVERER_H__

Generated by  doxygen 1.6.2