localconnectivityservice/dun/atext/inc/DunAtUrcHandler.h
author hgs
Thu, 04 Nov 2010 15:31:42 +0800
changeset 60 841f70763fbe
parent 29 3ae5cb0b4c02
permissions -rw-r--r--
201044_04
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     1
/*
60
841f70763fbe 201044_04
hgs
parents: 29
diff changeset
     2
* Copyright (c) 2008-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:  AT command URC handler
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_CDUNATURCHANDLER_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    20
#define C_CDUNATURCHANDLER_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    21
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    22
#include <atext.h>
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    23
#include "DunDataPusher.h"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    24
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    25
class MDunStreamManipulator;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    26
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    27
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    28
 *  Class for AT command URC handler
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    29
 *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    30
 *  @lib dunatext.lib
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    31
 *  @since TB9.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    32
 */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    33
NONSHARABLE_CLASS( CDunAtUrcHandler ) : public CActive,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    34
                                        public MDunCompletionReporter
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    35
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    36
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    37
public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    38
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    39
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    40
     * Two-phased constructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    41
     * @param aAtCmdExt Pointer to AT command extension
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    42
     * @param aStreamCallback Callback to stream
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    43
     * @return Instance of self
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    44
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    45
	static CDunAtUrcHandler* NewL( RATExt* aAtCmdExt,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    46
	                               MDunStreamManipulator* aStreamCallback );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    47
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    48
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    49
     * Two-phased constructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    50
     * @param aAtCmdExt Pointer to AT command extension
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    51
     * @param aStreamCallback Callback to stream
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    52
     * @return Instance of self
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    53
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    54
	static CDunAtUrcHandler* NewLC( RATExt* aAtCmdExt,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    55
	                                MDunStreamManipulator* aStreamCallback );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    56
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    57
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    58
    * Destructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    59
    */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    60
    virtual ~CDunAtUrcHandler();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    61
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    62
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    63
     * Resets data to initial values
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    64
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    65
     * @since TB9.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    66
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    67
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    68
    void ResetData();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    69
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    70
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    71
     * Starts waiting for an incoming URC message
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    72
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    73
     * @since TB9.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    74
     * @return Symbian error code on error, KErrNone otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    75
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    76
    TInt IssueRequest();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    77
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    78
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    79
     * Stops waiting for an incoming URC message
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    80
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    81
     * @since TB9.2
60
841f70763fbe 201044_04
hgs
parents: 29
diff changeset
    82
     * @return None
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    83
     */
60
841f70763fbe 201044_04
hgs
parents: 29
diff changeset
    84
    void Stop();
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    85
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    86
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    87
     * UID of the owning plugin
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    88
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    89
     * @since TB9.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    90
     * @return UID of the owning plugin
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    91
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    92
    TUid OwnerUid();
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    93
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    94
private:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    95
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    96
    CDunAtUrcHandler( RATExt* aAtCmdExt,
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    97
                      MDunStreamManipulator* aStreamCallback );
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 TB9.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 URC command received
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   114
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   115
     * @since TB9.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 TB9.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
// from base class MDunCompletionReporter
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   130
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   131
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   132
     * From MDunCompletionReporter.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   133
     * Gets called when data push is complete
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   134
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   135
     * @since TB9.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   136
     * @param aAllPushed ETrue if all in the queue were pushed, EFalse otherwise
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   137
     * @return None
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   138
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   139
    void NotifyDataPushComplete( TBool aAllPushed );
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   140
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   141
private:  // data
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   142
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   143
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   144
     * AT command extension
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
    RATExt* iAtCmdExt;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   148
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   149
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   150
     * Callback to call when data to push
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   151
     * Not own.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   152
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   153
    MDunStreamManipulator* iStreamCallback;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   154
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   155
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   156
     * Buffer for receiving
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   157
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   158
    TBuf8<KDefaultUrcBufLength> iRecvBuffer;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   159
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   160
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   161
     * UID of the responsible ATEXT plugin
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   162
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   163
    TUid iOwnerUid;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   164
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   165
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   166
     * Package for owner UID
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   167
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   168
    TPckg<TUid> iOwnerUidPckg;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   169
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   170
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   171
     * Flag to indicate start of receiving (for ownership marking)
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   172
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   173
    TBool iStarted;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   174
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   175
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   176
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
   177
#endif  // C_CDUNATURCHANDLER_H