bluetoothengine/btnotif/btnotifsrv/inc/btnotifdeviceselector.h
author hgs
Mon, 12 Jul 2010 18:51:05 +0300
changeset 42 b72428996822
parent 31 a0ea99b6fa53
child 47 9e2a905b887f
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     1
/*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     2
* ============================================================================
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     3
*  Name        : btnotifdeviceselector.h
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     4
*  Part of     : BTProximity / BTProximity
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     5
*  Description : Class for tracking Bluetooth settings, and also for 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     6
*                handling notes unrelated to specific connection.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     7
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     8
*  Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies).
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     9
*  All rights reserved.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    10
*  This component and the accompanying materials are made available
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    11
*  under the terms of "Eclipse Public License v1.0"
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    12
*  which accompanies this distribution, and is available
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    13
*  at the URL "http://www.eclipse.org/legal/epl-v10.html".
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    14
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    15
*  Initial Contributors:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    16
*  Nokia Corporation - initial contribution.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    17
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    18
*  Contributors:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    19
*  Nokia Corporation
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    20
* ============================================================================
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    21
* Template version: 4.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    22
*/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    23
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    24
#ifndef BTNOTIFDEVICESELECTOR_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    25
#define BTNOTIFDEVICESELECTOR_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    26
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    27
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    28
#include <e32base.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    29
#include <btengsettings.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    30
#include <btservices/devdiscoveryobserver.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    31
#include "bluetoothnotification.h"
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    32
#include <btservices/btdevrepository.h>
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    33
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    34
class CBTNotifServer;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    35
class CAdvanceDevDiscoverer;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    36
class CBtDevExtension;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    37
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    38
/**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    39
 *  ?one_line_short_description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    40
 *  ?more_complete_description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    41
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    42
 *  @code
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    43
 *   ?good_class_usage_example(s)
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    44
 *  @endcode
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    45
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    46
 *  @lib ?library
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    47
 *  @since S60 ?S60_version *** for example, S60 v3.0
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    48
 */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    49
NONSHARABLE_CLASS( CBTNotifDeviceSelector ) : 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    50
        public CBase,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    51
        public MBTNotificationResult,
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    52
        public MDevDiscoveryObserver,
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    53
        public MBtDevRepositoryObserver
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    54
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    55
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    56
public:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    57
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    58
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    59
     * Two-phased constructor.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    60
     * @param aServer Pointer to our parent
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    61
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    62
    static CBTNotifDeviceSelector* NewL( CBTNotifServer& aServer );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    63
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    64
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    65
    * Destructor.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    66
    */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    67
    virtual ~CBTNotifDeviceSelector();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    68
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    69
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    70
     * Processes a message from a notifier client related to settings.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    71
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    72
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    73
     * @param aMessage The message containing the details of the client request.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    74
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    75
    void DispatchNotifierMessageL( const RMessage2& aMessage );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    76
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    77
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    78
     * Cancels an oustanding message from a notifier client related to settings.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    79
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    80
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    81
     * @param aMessage The message containing the details of the original client request.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    82
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    83
    void CancelNotifierMessageL( const RMessage2& aMessage );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    84
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    85
private:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    86
// from base class MBTNotificationResult
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    87
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    88
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    89
     * From MBTNotificationResult.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    90
     * Handle an intermediate result from a user query.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    91
     * This ffunction is called if the user query passes information
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    92
     * back before it has finished i.e. is dismissed. The final acceptance/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    93
     * denial of a query is passed back in MBRNotificationClosed.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    94
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    95
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    96
     * @param aData the returned data. The actual format 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    97
     *              is dependent on the actual notifier.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    98
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    99
    virtual void MBRDataReceived( CHbSymbianVariantMap& aData );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   100
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   101
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   102
     * From MBTNotificationResult.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   103
     * The notification is finished. The resulting data (e.g. user input or
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   104
     * acceptance/denial of the query) is passed back here.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   105
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   106
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   107
     * @param aErr KErrNone or one of the system-wide error codes.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   108
     * @param aData the returned data. The actual format 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   109
     *              is dependent on the actual notifier.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   110
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   111
    virtual void MBRNotificationClosed( TInt aError, const TDesC8& aData );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   112
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   113
    // From MDevDiscoveryObserver
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   114
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   115
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   116
     * Callback to notify that a device has been found.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   117
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   118
     * @param aAddr the inquiry address that contains the inquiry information
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   119
     *  of the found device.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   120
     * @param aName the Bluetooth device name of the found device
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   121
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   122
    virtual void HandleNextDiscoveryResultL( 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   123
            const TInquirySockAddr& aAddr, const TDesC& aName );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   124
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   125
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   126
     * Callback to notify that the device search has completed.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   127
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   128
     * @param aErr the error code of device search result.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   129
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   130
    virtual void HandleDiscoveryCompleted( TInt aErr );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   131
    
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   132
    
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   133
    // From MBtDeviceRepositoryObserver
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   134
    
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   135
    void RepositoryInitialized();
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   136
    
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   137
    void DeletedFromRegistry( const TBTDevAddr& addr );
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   138
    
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   139
    void AddedToRegistry( const CBtDevExtension& dev );
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   140
    
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   141
    void ChangedInRegistry( const CBtDevExtension& dev, TUint similarity  ); 
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   142
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   143
    void ServiceConnectionChanged(
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   144
            const CBtDevExtension& dev, TBool connected );
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   145
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   146
    
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   147
private:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   148
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   149
    CBTNotifDeviceSelector( CBTNotifServer& aServer );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   150
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   151
    void ConstructL();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   152
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   153
    void PrepareNotificationL( 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   154
            TBluetoothDialogParams::TBTDialogType aType,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   155
            TBTDialogResourceId aResourceId );
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   156
			
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   157
	void LoadUsedDevicesL();		
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   158
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   159
private: // data    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   160
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   161
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   162
     * Reference to our parent the server class.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   163
     * Not own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   164
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   165
    CBTNotifServer& iServer;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   166
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   167
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   168
     * Pointer to an outstanding user interaction.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   169
     * Not own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   170
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   171
    CBluetoothNotification* iNotification;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   172
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   173
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   174
     * device inquiry handler:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   175
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   176
    CAdvanceDevDiscoverer* iDiscoverer;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   177
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   178
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   179
     * do not own the elements in the array.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   180
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   181
    RPointerArray<CBtDevExtension> iDevices;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   182
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   183
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   184
     * The message for a pending device selection request from a RNotifier client.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   185
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   186
    RMessage2 iMessage;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   187
    
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   188
    TBool iRepositoryInitialized;
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   189
    
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   190
    TBool iLoadDevices;
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
   191
    
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   192
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   193
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   194
#endif // BTNOTIFDEVICESELECTOR_H