satengine/satserver/SatInternalClient/src/CSatCNotifyHandler.cpp
author hgs
Fri, 03 Sep 2010 13:59:20 +0300
changeset 46 2fa1fa551b0b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  This is the handler for various notifications related to
hgs
parents:
diff changeset
    15
*                those SIM Application Toolkit proactive commands that
hgs
parents:
diff changeset
    16
*                uses notifications to inform user about their actions.
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// INCLUDE FILES
hgs
parents:
diff changeset
    23
#include    <e32base.h>
hgs
parents:
diff changeset
    24
#include    <e32svr.h>
hgs
parents:
diff changeset
    25
#include    "RSatUiSession.h"
hgs
parents:
diff changeset
    26
#include    "MSatUiObserver.h"
hgs
parents:
diff changeset
    27
#include    "SatSOpcodes.h"
hgs
parents:
diff changeset
    28
#include    "CSatCNotifyHandler.h"
hgs
parents:
diff changeset
    29
#include    "SatLog.h"
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// CONSTANTS
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// ============================ MEMBER FUNCTIONS ===============================
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    36
// CSatCNotifyHandler::CSatCNotifyHandler
hgs
parents:
diff changeset
    37
// C++ default constructor can NOT contain any code, that
hgs
parents:
diff changeset
    38
// might leave.
hgs
parents:
diff changeset
    39
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    40
//
hgs
parents:
diff changeset
    41
//lint -e{1403, 1769} Can not be initialized, harmless.
hgs
parents:
diff changeset
    42
CSatCNotifyHandler::CSatCNotifyHandler(
hgs
parents:
diff changeset
    43
    TInt aPriority,
hgs
parents:
diff changeset
    44
    RSatUiSession* aSession ) :
hgs
parents:
diff changeset
    45
    CActive( aPriority ),
hgs
parents:
diff changeset
    46
    iSession( aSession ),
hgs
parents:
diff changeset
    47
    iNotifyData(),
hgs
parents:
diff changeset
    48
    iNotifyPckg( iNotifyData ),
hgs
parents:
diff changeset
    49
    iNotifyRsp(),
hgs
parents:
diff changeset
    50
    iNotifyRspPckg( iNotifyRsp )
hgs
parents:
diff changeset
    51
    {
hgs
parents:
diff changeset
    52
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::CSatCNotifyHandler calling" )
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
    // Add to active scheduler.
hgs
parents:
diff changeset
    55
    CActiveScheduler::Add( this );
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::CSatCNotifyHandler exiting" )
hgs
parents:
diff changeset
    58
    }
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    61
// CSatCNotifyHandler::NewL
hgs
parents:
diff changeset
    62
// Two-phased constructor.
hgs
parents:
diff changeset
    63
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    64
//
hgs
parents:
diff changeset
    65
CSatCNotifyHandler* CSatCNotifyHandler::NewL(
hgs
parents:
diff changeset
    66
    RSatUiSession* aSat )
hgs
parents:
diff changeset
    67
    {
hgs
parents:
diff changeset
    68
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::NewL calling" )
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
    // Perform construction.
hgs
parents:
diff changeset
    71
    CSatCNotifyHandler* self =
hgs
parents:
diff changeset
    72
        new ( ELeave ) CSatCNotifyHandler( EPriorityLow, aSat );
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::NewL exiting" )
hgs
parents:
diff changeset
    75
    return self;
hgs
parents:
diff changeset
    76
    }
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
// Destructor
hgs
parents:
diff changeset
    79
CSatCNotifyHandler::~CSatCNotifyHandler()
hgs
parents:
diff changeset
    80
    {
hgs
parents:
diff changeset
    81
    LOG( SIMPLE,
hgs
parents:
diff changeset
    82
        "SATINTERNALCLIENT: CSatCNotifyHandler::~CSatCNotifyHandler calling" )
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
    // Cancel any outstanding requests.
hgs
parents:
diff changeset
    85
    Cancel();
hgs
parents:
diff changeset
    86
    iSession = NULL;
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
    LOG( SIMPLE,
hgs
parents:
diff changeset
    89
        "SATINTERNALCLIENT: CSatCNotifyHandler::~CSatCNotifyHandler exiting" )
hgs
parents:
diff changeset
    90
    }
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    93
// CSatCNotifyHandler::Start
hgs
parents:
diff changeset
    94
// Starts the handler.
hgs
parents:
diff changeset
    95
// (other items were commented in a header).
hgs
parents:
diff changeset
    96
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
    97
//
hgs
parents:
diff changeset
    98
void CSatCNotifyHandler::Start()
hgs
parents:
diff changeset
    99
    {
hgs
parents:
diff changeset
   100
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::Start calling" )
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    // Empty the IPC data
hgs
parents:
diff changeset
   103
    TSatNotificationV1 temp;
hgs
parents:
diff changeset
   104
    iNotifyData = temp;
hgs
parents:
diff changeset
   105
    TSatNotificationRspV1 temp2;
hgs
parents:
diff changeset
   106
    temp2.iAccepted = EFalse;
hgs
parents:
diff changeset
   107
    temp2.iCommand = ESatSSendDataNotify;
hgs
parents:
diff changeset
   108
    iNotifyRsp = temp2;
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
    // Request notification.
hgs
parents:
diff changeset
   111
    TIpcArgs arguments( &iNotifyPckg );
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
    // Pass the notification IPC package.
hgs
parents:
diff changeset
   114
    iSession->CreateRequest( ESatSProactiveNotification, arguments, iStatus );
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
    // Set this handler to active so that it can receive requests.
hgs
parents:
diff changeset
   117
    SetActive();
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::Start exiting" )
hgs
parents:
diff changeset
   120
    }
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   123
// CSatCNotifyHandler::RunL
hgs
parents:
diff changeset
   124
// Handles the command.
hgs
parents:
diff changeset
   125
// (other items were commented in a header).
hgs
parents:
diff changeset
   126
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   127
//
hgs
parents:
diff changeset
   128
void CSatCNotifyHandler::RunL()
hgs
parents:
diff changeset
   129
    {
hgs
parents:
diff changeset
   130
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::RunL calling" )
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
    // Check the status of the asnychronous operation
hgs
parents:
diff changeset
   133
    if ( KErrNone != iStatus.Int() )
hgs
parents:
diff changeset
   134
        {
hgs
parents:
diff changeset
   135
        LOG2(
hgs
parents:
diff changeset
   136
            SIMPLE,
hgs
parents:
diff changeset
   137
            "SATINTERNALCLIENT: CSatCNotifyHandler::RunL error: %d",
hgs
parents:
diff changeset
   138
            iStatus.Int() )
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
        // Renew the request
hgs
parents:
diff changeset
   141
        Start();
hgs
parents:
diff changeset
   142
        }
hgs
parents:
diff changeset
   143
hgs
parents:
diff changeset
   144
    else
hgs
parents:
diff changeset
   145
        {
hgs
parents:
diff changeset
   146
        // This will contain the result of the user query.
hgs
parents:
diff changeset
   147
        TBool userQuery( ETrue );
hgs
parents:
diff changeset
   148
hgs
parents:
diff changeset
   149
        // This will contain EFalse if requested icon is not displayed.
hgs
parents:
diff changeset
   150
        // And if icon is displayed, it contains ETrue.
hgs
parents:
diff changeset
   151
        TBool requestedIconDisplayed( EFalse );
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
        // This will contain the result that has the user pressed end key.
hgs
parents:
diff changeset
   154
        TBool terminatedByUser( EFalse );
hgs
parents:
diff changeset
   155
        
hgs
parents:
diff changeset
   156
        // Has to be casted to TInt before casting to TSatIconQualifier, because
hgs
parents:
diff changeset
   157
        // GCC warns about the direct cast.
hgs
parents:
diff changeset
   158
        const struct TSatIconId iconId =
hgs
parents:
diff changeset
   159
            {
hgs
parents:
diff changeset
   160
            iNotifyData.iIconId.iIdentifier,
hgs
parents:
diff changeset
   161
                static_cast<TSatIconQualifier>(
hgs
parents:
diff changeset
   162
                    static_cast<TInt>(
hgs
parents:
diff changeset
   163
                        iNotifyData.iIconId.iIconQualifier ) )
hgs
parents:
diff changeset
   164
            };
hgs
parents:
diff changeset
   165
hgs
parents:
diff changeset
   166
        // Send notification to UI
hgs
parents:
diff changeset
   167
        TSatUiResponse response = iSession->SatUiObserver()->Notification(
hgs
parents:
diff changeset
   168
            iNotifyData.iCommand,
hgs
parents:
diff changeset
   169
            iNotifyData.iAlphaIdStatus,
hgs
parents:
diff changeset
   170
            iNotifyData.iText,
hgs
parents:
diff changeset
   171
            iconId,
hgs
parents:
diff changeset
   172
            requestedIconDisplayed,
hgs
parents:
diff changeset
   173
            iNotifyData.iControlResult );
hgs
parents:
diff changeset
   174
        
hgs
parents:
diff changeset
   175
        // Check response
hgs
parents:
diff changeset
   176
        if ( ESatSuccess != response )
hgs
parents:
diff changeset
   177
            {
hgs
parents:
diff changeset
   178
            LOG( SIMPLE, 
hgs
parents:
diff changeset
   179
            "SATINTERNALCLIENT: CSatCNotifyHandler::RunL ESatSuccess != response" )
hgs
parents:
diff changeset
   180
            terminatedByUser = ETrue;
hgs
parents:
diff changeset
   181
            }
hgs
parents:
diff changeset
   182
        
hgs
parents:
diff changeset
   183
        // Indicate SAT Server that notification is complete
hgs
parents:
diff changeset
   184
        iNotifyRsp.iCommand = iNotifyData.iCommand;
hgs
parents:
diff changeset
   185
        iNotifyRsp.iRequestedIconDisplayed = requestedIconDisplayed;
hgs
parents:
diff changeset
   186
        iNotifyRsp.iSessionTerminatedByUser = terminatedByUser;
hgs
parents:
diff changeset
   187
        iNotifyRsp.iAccepted = userQuery;
hgs
parents:
diff changeset
   188
hgs
parents:
diff changeset
   189
        // Pass the notification response IPC package.
hgs
parents:
diff changeset
   190
        TIpcArgs arguments( &iNotifyRspPckg );
hgs
parents:
diff changeset
   191
hgs
parents:
diff changeset
   192
        // Perform the IPC data transfer.
hgs
parents:
diff changeset
   193
        iSession->CreateRequest( ESatSProactiveNotificationResponse, arguments );
hgs
parents:
diff changeset
   194
hgs
parents:
diff changeset
   195
        Start();
hgs
parents:
diff changeset
   196
        }
hgs
parents:
diff changeset
   197
hgs
parents:
diff changeset
   198
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::RunL exiting" )
hgs
parents:
diff changeset
   199
    }
hgs
parents:
diff changeset
   200
hgs
parents:
diff changeset
   201
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   202
// CSatCNotifyHandler::DoCancel
hgs
parents:
diff changeset
   203
// Cancels the pending request.
hgs
parents:
diff changeset
   204
// (other items were commented in a header).
hgs
parents:
diff changeset
   205
// -----------------------------------------------------------------------------
hgs
parents:
diff changeset
   206
//
hgs
parents:
diff changeset
   207
void CSatCNotifyHandler::DoCancel()
hgs
parents:
diff changeset
   208
    {
hgs
parents:
diff changeset
   209
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::DoCancel calling" )
hgs
parents:
diff changeset
   210
hgs
parents:
diff changeset
   211
    // Complete the request with cancel code.
hgs
parents:
diff changeset
   212
    TRequestStatus* requestStatus = &iStatus;
hgs
parents:
diff changeset
   213
    User::RequestComplete( requestStatus, KErrCancel );
hgs
parents:
diff changeset
   214
hgs
parents:
diff changeset
   215
    LOG( SIMPLE, "SATINTERNALCLIENT: CSatCNotifyHandler::DoCancel exiting" )
hgs
parents:
diff changeset
   216
    }
hgs
parents:
diff changeset
   217
hgs
parents:
diff changeset
   218
//  End of File