bluetoothengine/bteng/btengconnman/inc/btengpairinghandler.h
author hgs
Mon, 03 May 2010 14:36:07 +0300
changeset 29 48ae3789ce00
permissions -rw-r--r--
201017_2
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
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     3
* All rights reserved.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     8
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     9
* Initial Contributors:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    11
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    12
* Contributors:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    13
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    14
* Description:  Bluetooth Engine API for connection management functionality.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    15
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    16
*/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    17
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    18
#ifndef BTENGPAIRINGHANDLER_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    19
#define BTENGPAIRINGHANDLER_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    20
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    21
#include <btnotifclient.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    22
#include <btmanclient.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    23
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    24
#include "btengactive.h"
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    25
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    26
class CBTEngConnMan;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    27
class MBTEngConnObserver;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    28
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    30
/**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    31
 *  ?one_line_short_description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    32
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    33
 *  ?more_complete_description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    34
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    35
 *  @lib ?library
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    36
 *  @since S60 v3.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    37
 */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    38
NONSHARABLE_CLASS( CBTEngPairingHandler ) : public CBase, public MBTEngActiveObserver
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    39
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    40
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    41
public:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    42
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    43
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    44
     * Two-phase constructor
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    45
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    46
    static CBTEngPairingHandler* NewL( MBTEngConnObserver* aObserver, 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    47
                                        CBTEngConnMan* aParent );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    48
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    49
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    50
     * Destructor
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    51
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    52
    virtual ~CBTEngPairingHandler();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    53
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    54
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    55
     * ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    56
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    57
     * @since S60 v3.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    58
     * @param ?arg1 ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    59
     * @param ?arg2 ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    60
     * @return ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    61
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    62
    void StartPairingL( const TBTDevAddr& aAddr, TBTDeviceClass& aDeviceClass );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    63
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    64
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    65
     * ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    66
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    67
     * @since S60 v3.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    68
     * @param ?arg1 ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    69
     * @param ?arg2 ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    70
     * @return ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    71
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    72
    void CancelPairing();   
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    73
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    74
// from base class MBTEngActiveObserver
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    75
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    76
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    77
     * From MBTEngActiveObserver.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    78
     * ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    79
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    80
     * @since S60 v3.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    81
     * @param ?arg1 ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    82
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    83
    virtual void RequestCompletedL( CBTEngActive* aActive, 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    84
                                    TInt aStatus );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    85
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    86
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    87
     * Callback for handling cancelation of an outstanding request.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    88
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    89
     * @param aId The ID that identifies the outstanding request.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    90
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    91
    virtual void CancelRequest( TInt aRequestId );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    92
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    93
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    94
     * From MBTEngActiveObserver.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    95
     * ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    96
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    97
     * @since S60 v3.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    98
     * @param ?arg1 ?description
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    99
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   100
    virtual void HandleError( CBTEngActive* aActive, 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   101
                                    TInt aError );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   102
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   103
private:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   104
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   105
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   106
     * C++ default constructor
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   107
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   108
    CBTEngPairingHandler( MBTEngConnObserver* aObserver, 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   109
                           CBTEngConnMan* aParent );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   110
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   111
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   112
     * Symbian 2nd-phase constructor
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   113
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   114
    void ConstructL();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   115
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   116
private: // data
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   117
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   118
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   119
     * the address of the remote device to be paired.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   120
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   121
    TBTDevAddrPckgBuf iAddr;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   122
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   123
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   124
     * the class of device value of the remote device to be paired.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   125
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   126
    TBTDeviceClass iCod; 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   127
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   128
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   129
     * the session to notifier which handles the actual pairing operation.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   130
     * Own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   131
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   132
    RBTNotifier iBtNotifier;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   133
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   134
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   135
     * Active object for pairing request
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   136
     * Own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   137
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   138
    CBTEngActive* iActive;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   139
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   140
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   141
     * the observer that receives the result of pairing operation.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   142
     * Not own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   143
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   144
    MBTEngConnObserver* iObserver;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   145
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   146
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   147
     * ?description_of_pointer_member
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   148
     * Not own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   149
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   150
    CBTEngConnMan* iParent;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   151
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   152
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   153
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   154
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   155
#endif // BTENGPAIRINGHANDLER_H