localconnectivityservice/dun/utils/inc/DunDataWaiter.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:  Monitors for new data in RComm local media side
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_CDUNDATAWAITER_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    20
#define C_CDUNDATAWAITER_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    21
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    22
#include "DunChanMan.h"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    23
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    24
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    25
 *  Class to monitor for new data in RComm local media side
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    26
 *  This class is needed to avoid unnecessary resource allocation of Dataport
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    27
 *  side when number of supported Dataport ports for DUN is less than the
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    28
 *  number of local media side plugins that use RComm
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    29
 *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    30
 *  @lib dunutils.lib
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    31
 *  @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    32
 */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    33
NONSHARABLE_CLASS( CDunDataWaiter ) : public CActive
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    34
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    35
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    36
public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    37
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    38
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    39
     * Two-phased constructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    40
     * @param aChannelCallback Callback to call when notification via
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    41
     *                         MDunChannelAllocator to be made
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    42
     * @return Instance of self
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    43
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    44
	static CDunDataWaiter* NewL( MDunChannelAllocator* aChannelCallback );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    45
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    46
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    47
    * Destructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    48
    */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    49
    virtual ~CDunDataWaiter();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    50
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    51
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    52
     * Resets data to initial values
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    53
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    54
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    55
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    56
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    57
    void ResetData();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    58
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    59
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    60
     * Adds callback for RunL error controlling
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    61
     * The callback will be called when error is detected in asynchronous
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    62
     * operation
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    63
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    64
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    65
     * @param aCallback Callback to call when line status changes
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    66
     * @return Symbian error code on error, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    67
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    68
    TInt AddCallback( MDunConnMon* aCallback );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    69
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    70
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    71
     * Sets media to use for this endpoint
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    72
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    73
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    74
     * @param aComm RComm pointer to use as the endpoint
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    75
     * @return Symbian error code on error, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    76
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    77
    TInt SetMedia( RComm* aComm );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    78
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    79
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    80
     * Issues request to start waiting for new data in RComm
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    81
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    82
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    83
     * @return Symbian error code on error, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    84
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    85
    TInt IssueRequest();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    86
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    87
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    88
     * Stops monitoring for new data
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    89
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    90
     * @since S60 3.2
54
4dc88a4ac6f4 201041_02
hgs
parents: 29
diff changeset
    91
     * @return None
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    92
     */
54
4dc88a4ac6f4 201041_02
hgs
parents: 29
diff changeset
    93
    void Stop();
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    94
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    95
private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    96
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    97
    CDunDataWaiter( MDunChannelAllocator* aChannelCallback );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    98
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    99
    void ConstructL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   100
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   101
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   102
     * Initializes this class
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   103
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   104
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   105
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   106
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   107
    void Initialize();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   108
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   109
// from base class CActive
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   110
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   111
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   112
     * From CActive.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   113
     * Gets called when new data in RComm object
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   114
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   115
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   116
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   117
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   118
    void RunL();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   119
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   120
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   121
     * From CActive.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   122
     * Gets called on cancel
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   123
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   124
     * @since S60 3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   125
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   126
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   127
    void DoCancel();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   128
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   129
private:  // data
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   130
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   131
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   132
     * Callback(s) to call when notification(s) via MDunConnMon to be made
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   133
     * Normally contains only one callback
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   134
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   135
    RPointerArray<MDunConnMon> iCallbacks;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   136
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   137
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   138
     * Callback to call when notification via MDunChannelAllocator to be made
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   139
     * Not own.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   140
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   141
    MDunChannelAllocator* iChannelCallback;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   142
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   143
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   144
     * RComm object of local media side
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   145
     * Not own.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   146
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   147
    RComm* iComm;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   148
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   149
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   150
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   151
#endif  // C_CDUNDATAWAITER_H