localconnectivityservice/dun/plugins/inc/usb/DunUsbListen.h
author hgs
Fri, 15 Oct 2010 15:05:57 +0800
changeset 54 4dc88a4ac6f4
parent 29 3ae5cb0b4c02
permissions -rw-r--r--
201041_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     1
/*
54
4dc88a4ac6f4 201041_02
hgs
parents: 29
diff changeset
     2
* Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     3
* All rights reserved.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     8
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     9
* Initial Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    11
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    12
* Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    13
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    14
* Description:  DUN USB plugin's listener
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    15
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    16
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    17
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    18
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    19
#ifndef C_CDUNUSBLISTEN_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    20
#define C_CDUNUSBLISTEN_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    21
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    22
#include <e32std.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    23
#include <c32comm.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    24
#include <usbman.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    25
#include "DunPlugin.h"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    26
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    27
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    28
 *  DUN USB plugin's listener class
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    29
 *  This class starts listening for USB device state to change to configured.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    30
 *  When change to configured is detected, parent (CDunUsbPlugin) is notified
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    31
 *  to create a channel. Also when device state is no longer configured,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    32
 *  parent (CDunUsbPlugin) is notified to remove a channel.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    33
 *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    34
 *  @lib dunusb.lib
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    35
 *  @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    36
 */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    37
NONSHARABLE_CLASS( CDunUsbListen ) : public CActive
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    38
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    39
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    40
public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    41
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    42
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    43
     * Two-phased constructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    44
     * @param aServer Server
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    45
     * @param aParent Creator of this instance
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    46
     * @param aUsbServer USB server
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    47
     * @return Instance of self
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    48
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    49
    static CDunUsbListen* NewL( MDunServerCallback* aServer,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    50
                                MDunListenCallback* aParent,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    51
                                RUsb& aUsbServer );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    52
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    53
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    54
    * Destructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    55
    */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    56
    virtual ~CDunUsbListen();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    57
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    58
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    59
     * Resets data to initial values
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    60
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    61
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    62
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    63
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    64
    void ResetData();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    65
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    66
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    67
     * IssueRequest to USB server for device state change notifications
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    68
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    69
     * @return KErrAlreadyExists if device state configured,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    70
     *         KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    71
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    72
    TInt IssueRequestL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    73
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    74
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    75
     * Stops listening
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    76
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    77
     * @since S60 3.2
54
4dc88a4ac6f4 201041_02
hgs
parents: 29
diff changeset
    78
     * @return None
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    79
     */
54
4dc88a4ac6f4 201041_02
hgs
parents: 29
diff changeset
    80
    void Stop();
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    81
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    82
private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    83
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    84
    CDunUsbListen( MDunServerCallback* aServer,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    85
                   MDunListenCallback* aParent,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    86
                   RUsb& aUsbServer );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    87
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    88
    void ConstructL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    89
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    90
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    91
     * Initializes this class
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    92
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    93
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    94
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    95
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    96
    void Initialize();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    97
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    98
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    99
     * Activates listening request
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   100
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   101
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   102
     * @return KErrNotReady if already active, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   103
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   104
    TInt Activate();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   105
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   106
// from base class CActive
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   107
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   108
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   109
     * From CActive.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   110
     * Called when read or write operation is ready.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   111
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   112
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   113
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   114
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   115
    void RunL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   116
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   117
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   118
     * From CActive.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   119
     * Cancel current activity.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   120
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   121
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   122
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   123
    void DoCancel();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   124
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   125
private:  // data
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   126
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   127
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   128
     * Callback to call when notification via MDunServerCallback to be made
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   129
     * Not own.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   130
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   131
    MDunServerCallback* iServer;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   132
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   133
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   134
     * Callback to call when notification via MDunListenCallback to be made
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   135
     * Not own.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   136
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   137
    MDunListenCallback* iParent;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   138
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   139
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   140
     * USB server (USB manager) needed for device state notifications
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   141
     * Device states needed to create transporter channel
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   142
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   143
    RUsb& iUsbServer;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   144
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   145
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   146
     * Device state of USB set when RUsb::DeviceStateNotification completes
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   147
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   148
    TUsbDeviceState iDeviceState;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   149
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   150
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   151
     * Previous state of USB set when RUsb::DeviceStateNotification completes
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   152
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   153
    TUsbDeviceState iDeviceStatePrev;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   154
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   155
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   156
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   157
#endif  // C_CDUNUSBLISTEN_H