satengine/satserver/Commands/RefreshCmd/inc/CRefreshHandler.h
author hgs
Fri, 15 Oct 2010 13:21:28 +0300 (2010-10-15)
changeset 53 25b8d29b7c59
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2007 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:  Refresh command handler
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef CREFRESHHANDLER_H
hgs
parents:
diff changeset
    21
#define CREFRESHHANDLER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include <etelsat.h>
hgs
parents:
diff changeset
    25
#include "SatSTypes.h"
hgs
parents:
diff changeset
    26
#include "CSatCommandHandler.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// FORWARD DECLARATION
hgs
parents:
diff changeset
    29
class MSatUtils;
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// CLASS DECLARATION
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
*  Command handler for Refresh command.
hgs
parents:
diff changeset
    35
*
hgs
parents:
diff changeset
    36
*  @lib RefreshCmd.lib
hgs
parents:
diff changeset
    37
*  @since Series 60 3.0
hgs
parents:
diff changeset
    38
*/
hgs
parents:
diff changeset
    39
class CRefreshHandler : public CSatCommandHandler
hgs
parents:
diff changeset
    40
    {
hgs
parents:
diff changeset
    41
    public:     // Constructors and destructor
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
        /**
hgs
parents:
diff changeset
    44
        * Two-phased constructor.
hgs
parents:
diff changeset
    45
        * @param aUtils SAT Utils interface
hgs
parents:
diff changeset
    46
        */
hgs
parents:
diff changeset
    47
        static CRefreshHandler* NewL( MSatUtils* aUtils );
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
        /**
hgs
parents:
diff changeset
    50
        * Destructor.
hgs
parents:
diff changeset
    51
        */
hgs
parents:
diff changeset
    52
        virtual ~CRefreshHandler();
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
    public:     // Functions from base classes
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
        /**
hgs
parents:
diff changeset
    57
        * From MSatEventObserver. Overrides the default implementation.
hgs
parents:
diff changeset
    58
        * @param aEvent An event that is occured.
hgs
parents:
diff changeset
    59
        */
hgs
parents:
diff changeset
    60
        void Event( TInt aEvent );
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    protected:  // Functions from base classes
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
        /**
hgs
parents:
diff changeset
    65
        * From CActive Cancels the usat request.
hgs
parents:
diff changeset
    66
        */
hgs
parents:
diff changeset
    67
        void DoCancel();
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
        /**
hgs
parents:
diff changeset
    70
        * From CCommandHandler Requests the command notification.
hgs
parents:
diff changeset
    71
        * @param aStatus Request status
hgs
parents:
diff changeset
    72
        */
hgs
parents:
diff changeset
    73
        void IssueUSATRequest( TRequestStatus& aStatus );
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
        /**
hgs
parents:
diff changeset
    76
        * From CSatCommandHandler Precheck before executing the command.
hgs
parents:
diff changeset
    77
        * @return TBool indicating command is currently allowed.
hgs
parents:
diff changeset
    78
        */
hgs
parents:
diff changeset
    79
        TBool CommandAllowed();
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
        /**
hgs
parents:
diff changeset
    82
        * From CSatCommandHandler Need for ui session.
hgs
parents:
diff changeset
    83
        * @return TBool indicating need of ui session.
hgs
parents:
diff changeset
    84
        */
hgs
parents:
diff changeset
    85
        TBool NeedUiSession();
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
        /**
hgs
parents:
diff changeset
    88
        * From CSatCommandHandler Called when USAT API notifies that command.
hgs
parents:
diff changeset
    89
        */
hgs
parents:
diff changeset
    90
        void HandleCommand();
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
        /**
hgs
parents:
diff changeset
    93
        * From CSatCommandHandler. Indicates the failure of launching ui client.
hgs
parents:
diff changeset
    94
        */
hgs
parents:
diff changeset
    95
        void UiLaunchFailed();
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
    private:
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
        /**
hgs
parents:
diff changeset
   100
        * C++ default constructor.
hgs
parents:
diff changeset
   101
        */
hgs
parents:
diff changeset
   102
        CRefreshHandler();
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
        /**
hgs
parents:
diff changeset
   105
        * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
   106
        */
hgs
parents:
diff changeset
   107
        void ConstructL();
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
    private:    // New functions
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
        /**
hgs
parents:
diff changeset
   112
        * Notifies the refresh clients about refresh cancel.
hgs
parents:
diff changeset
   113
        */
hgs
parents:
diff changeset
   114
        void NotifyRefreshClientsCancel();
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
        /**
hgs
parents:
diff changeset
   117
        * Completes refresh when all clients has completed.
hgs
parents:
diff changeset
   118
        */
hgs
parents:
diff changeset
   119
        void CompleteRefresh();
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
    private:    // Data
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
        // Refresh command data.
hgs
parents:
diff changeset
   124
        RSat::TRefreshV2 iRefreshData;
hgs
parents:
diff changeset
   125
hgs
parents:
diff changeset
   126
        // Refresh command package.
hgs
parents:
diff changeset
   127
        RSat::TRefreshV2Pckg iRefreshPckg;
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
        // Response from client
hgs
parents:
diff changeset
   130
        RSat::TRefreshRspV1 iRefreshRsp;
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
        // Response package.
hgs
parents:
diff changeset
   133
        RSat::TRefreshRspV1Pckg iRefreshRspPckg;
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
        // Count of refresh clients notified refresh but not yet answered.
hgs
parents:
diff changeset
   136
        TInt iRefreshNotifyClientCount;
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
        // True whether any client has indicated additional EF read.
hgs
parents:
diff changeset
   139
        TBool iAdditionalEFRead;
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
        // Indicates SimReset type refresh is executing.
hgs
parents:
diff changeset
   142
        TBool iSimResetExecuting;
hgs
parents:
diff changeset
   143
    };
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
#endif      // CREFRESHHANDLER_H
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
// End of File