bluetoothengine/btnotif/btnotifsrv/inc/btnotifincomingpairinghandler.h
author hgs
Mon, 12 Jul 2010 18:51:05 +0300
changeset 42 b72428996822
parent 31 a0ea99b6fa53
child 57 5ebadcda06cb
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
31
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     1
/*
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     3
* All rights reserved.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     8
*
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    11
*
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    12
* Contributors:
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    13
*
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    14
* Description: 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    15
*
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    16
*/
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    17
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    18
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    19
#ifndef BTNOTIFINCOMINGPAIRINGHANDLER_H
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    20
#define BTNOTIFINCOMINGPAIRINGHANDLER_H
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    21
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    22
#include <bt_sock.h>
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    23
#include "btnotifBasePairingHandler.h"
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    24
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    25
/**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    26
 *  Class CBTNotifIncomingPairingHandler
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    27
 *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    28
 *  Handles an incoming pairing.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    29
 *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    30
 *  @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    31
 */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    32
NONSHARABLE_CLASS( CBTNotifIncomingPairingHandler ) : public CBTNotifBasePairingHandler
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    33
    {
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    34
public:
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    35
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    36
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    37
     * Two-phase constructor
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    38
     * @param aParent the owner of this observer
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    39
     * @param aAddr the remote device this observer is targeted to
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    40
     */
42
hgs
parents: 31
diff changeset
    41
    static CBTNotifBasePairingHandler* NewL( CBTNotifSecurityManager& aParent, 
31
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    42
            const TBTDevAddr& aAddr);
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    43
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    44
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    45
     * Destructor
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    46
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    47
    ~CBTNotifIncomingPairingHandler();
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    48
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    49
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    50
private: // From CBTNotifBasePairingHandler
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    51
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    52
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    53
     * Start observing the result of pairing which was originated from
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    54
     * the remote device.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    55
     * @param the address of the remote device to be paired
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    56
     * @return KErrNone if this request is accepted; otherwise an error code
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    57
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    58
    TInt ObserveIncomingPair( const TBTDevAddr& aAddr );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    59
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    60
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    61
     * Start an outgoing pairing with the remote device.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    62
     * @param the address of the remote device to be paired
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    63
     * @return KErrNone if this request is accepted; otherwise an error code
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    64
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    65
    void HandleOutgoingPairL( const TBTDevAddr& aAddr, TUint aCod );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    66
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    67
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    68
     * Cancels pairing handling with the specified device
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    69
     * @param aAddr the address of the device the pairing is with
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    70
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    71
    void StopPairHandling( const TBTDevAddr& aAddr );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    72
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    73
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    74
     * Handle a pairing result with the remote device which this is for.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    75
     * Must be specialized by subclass.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    76
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    77
     * @param aResult The status code of the pairing or authentication result.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    78
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    79
    void DoHandlePairServerResult( TInt aResult );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    80
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    81
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    82
     * Handles event of registry new paired event with the remote 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    83
     * device this is for.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    84
     * @aType the type of authentication with the device.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    85
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    86
    void DoHandleRegistryNewPairedEvent( const TBTNamelessDevice& aDev );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    87
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    88
private: // from base class MBtSimpleActiveObserver
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    89
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    90
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    91
     * Callback to notify that an outstanding request has completed.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    92
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    93
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    94
     * @param aActive Pointer to the active object that completed.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    95
     * @param aId The ID that identifies the outstanding request.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    96
     * @param aStatus The status of the completed request.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    97
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    98
    virtual void RequestCompletedL( CBtSimpleActive* aActive, TInt aStatus );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
    99
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   100
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   101
     * Callback from Docancel() for handling cancelation of an outstanding request.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   102
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   103
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   104
     * @param aId The ID that identifies the outstanding request.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   105
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   106
    virtual void CancelRequest( TInt aRequestId );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   107
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   108
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   109
     * Callback to notify that an error has occurred in RunL.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   110
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   111
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   112
     * @param aActive Pointer to the active object that completed.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   113
     * @param aId The ID that identifies the outstanding request.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   114
     * @param aStatus The status of the completed request.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   115
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   116
    virtual void HandleError( CBtSimpleActive* aActive, TInt aError );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   117
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   118
private:
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   119
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   120
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   121
     * C++ default constructor
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   122
     */
42
hgs
parents: 31
diff changeset
   123
    CBTNotifIncomingPairingHandler(CBTNotifSecurityManager& aParent, const TBTDevAddr& aAddr);
31
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   124
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   125
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   126
     * 2nd phase constructor.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   127
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   128
    void ConstructL();
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   129
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   130
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   131
     * Start monitoring physical link events if it hasn't yet.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   132
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   133
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   134
     * 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   135
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   136
    void MonitorPhysicalLink();
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   137
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   138
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   139
     * Opens physical link adaptor with the device.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   140
     * 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   141
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   142
     * @return KErrNone if the physical link exists.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   143
     * 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   144
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   145
    TInt OpenPhysicalLinkAdaptor();
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   146
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   147
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   148
     * Cancel all outstanding requests.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   149
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   150
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   151
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   152
    void CancelPlaNotification();
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   153
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   154
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   155
     * Handle a physical link event.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   156
     *
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   157
     * @since Symbian^4
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   158
     * @param aResult The status code of the event.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   159
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   160
    void HandlePhysicalLinkResultL( TInt aResult );
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   161
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   162
private:
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   163
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   164
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   165
     * Package buffer for retrieving physical link events.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   166
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   167
    TBTBasebandEvent iBbEvent;
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   168
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   169
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   170
     * Subsession with the socket server for 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   171
     * getting physical link event notifications.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   172
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   173
    RBTPhysicalLinkAdapter iPla;
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   174
    
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   175
    /**
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   176
     * iPairingOkTimer is activated if the link goes down.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   177
     * If it expires it means the pairing process has failed, 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   178
     * then the error popup will be shown.
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   179
     * If the pairing process ends correctly, DoHandleRegistryNewPairedEvent 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   180
     * will be called and it will cancel the timer. 
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   181
     * iActivePairingOk is the active object associated to the timer.  
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   182
     */
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   183
    RTimer iPairingOkTimer;
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   184
    CBtSimpleActive* iActivePairingOk;
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   185
    TBool iUserAwarePairing;
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   186
    };
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   187
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   188
#endif /*BTNOTIFINCOMINGPAIRINGHANDLER_H*/
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   189
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   190
a0ea99b6fa53 201019_1
hgs
parents:
diff changeset
   191