satengine/satserver/Commands/CloseChannelCmd/inc/CCloseChannelHandler.h
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-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:  CloseChannel 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 CCLOSECHANNELHANDLER_H
hgs
parents:
diff changeset
    21
#define CCLOSECHANNELHANDLER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include <etelsat.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#include "CSatCommandHandler.h"
hgs
parents:
diff changeset
    26
#include "SatSTypes.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
class MSatUtils;
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// CLASS DECLARATION
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
/**
hgs
parents:
diff changeset
    33
*  Command handler for CloseChannel command.
hgs
parents:
diff changeset
    34
*
hgs
parents:
diff changeset
    35
*  @lib CloseChannelCmd.lib
hgs
parents:
diff changeset
    36
*  @since Series 60 v3.0
hgs
parents:
diff changeset
    37
*/
hgs
parents:
diff changeset
    38
class CCloseChannelHandler : public CSatCommandHandler
hgs
parents:
diff changeset
    39
    {
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
public:
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    static CCloseChannelHandler* NewL( MSatUtils* aUtils );
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
    virtual ~CCloseChannelHandler();
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
// from base class MSatCommand
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
    /**
hgs
parents:
diff changeset
    50
     * From MSatCommand.
hgs
parents:
diff changeset
    51
     * Response from the client
hgs
parents:
diff changeset
    52
     *
hgs
parents:
diff changeset
    53
     */
hgs
parents:
diff changeset
    54
    void ClientResponse();
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
protected:
hgs
parents:
diff changeset
    57
    
hgs
parents:
diff changeset
    58
// from base class CActive
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
    /**
hgs
parents:
diff changeset
    61
     * From CActive.
hgs
parents:
diff changeset
    62
     * Cancels the usat request.
hgs
parents:
diff changeset
    63
     *
hgs
parents:
diff changeset
    64
     */
hgs
parents:
diff changeset
    65
    void DoCancel();
hgs
parents:
diff changeset
    66
    
hgs
parents:
diff changeset
    67
// from base class CSatCommandHandler
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * From CSatCommandHandler.
hgs
parents:
diff changeset
    71
     * Requests the command notification.
hgs
parents:
diff changeset
    72
     *
hgs
parents:
diff changeset
    73
     * @param aStatus Request status to active object notification
hgs
parents:
diff changeset
    74
     */
hgs
parents:
diff changeset
    75
    void IssueUSATRequest( TRequestStatus& aStatus );
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * From CSatCommandHandler.
hgs
parents:
diff changeset
    79
     * Precheck before executing the command.
hgs
parents:
diff changeset
    80
     *
hgs
parents:
diff changeset
    81
     * @return TBool indicating is this command allowed to execute.
hgs
parents:
diff changeset
    82
     */
hgs
parents:
diff changeset
    83
    TBool CommandAllowed();
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
    /**
hgs
parents:
diff changeset
    86
     * From CSatCommandHandler.
hgs
parents:
diff changeset
    87
     * Need for ui session.
hgs
parents:
diff changeset
    88
     *
hgs
parents:
diff changeset
    89
     * @return TBool indicating does this command need UI session.
hgs
parents:
diff changeset
    90
     */
hgs
parents:
diff changeset
    91
    TBool NeedUiSession();
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
    /**
hgs
parents:
diff changeset
    94
     * From CSatCommandHandler.
hgs
parents:
diff changeset
    95
     * Called when USAT API notifies that command.
hgs
parents:
diff changeset
    96
     *
hgs
parents:
diff changeset
    97
     */
hgs
parents:
diff changeset
    98
    void HandleCommand();
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
     * From CSatCommandHandler.
hgs
parents:
diff changeset
   102
     * Indicates the failure of launching ui client.
hgs
parents:
diff changeset
   103
     *
hgs
parents:
diff changeset
   104
     */
hgs
parents:
diff changeset
   105
    void UiLaunchFailed();
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
private:
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
    CCloseChannelHandler();
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
    /**
hgs
parents:
diff changeset
   112
     * Sends notification to UI.
hgs
parents:
diff changeset
   113
     *
hgs
parents:
diff changeset
   114
     * @return KErrNone if notification is sent successfully
hgs
parents:
diff changeset
   115
     */
hgs
parents:
diff changeset
   116
    TInt SendUiNotification();
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
private: // data
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
    /**
hgs
parents:
diff changeset
   121
     * CloseChannel command data
hgs
parents:
diff changeset
   122
     */
hgs
parents:
diff changeset
   123
    RSat::TCloseChannelV2 iCloseChannelData;
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
    /**
hgs
parents:
diff changeset
   126
     * CloseChannel command package
hgs
parents:
diff changeset
   127
     */
hgs
parents:
diff changeset
   128
    RSat::TCloseChannelV2Pckg iCloseChannelPckg;
hgs
parents:
diff changeset
   129
hgs
parents:
diff changeset
   130
    /**
hgs
parents:
diff changeset
   131
     * CloseChannel response data
hgs
parents:
diff changeset
   132
     */
hgs
parents:
diff changeset
   133
    RSat::TCloseChannelRspV2 iCloseChannelRspData;
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
    /**
hgs
parents:
diff changeset
   136
     * CloseChannel response package
hgs
parents:
diff changeset
   137
     */
hgs
parents:
diff changeset
   138
    RSat::TCloseChannelRspV2Pckg iCloseChannelRspPckg;
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
    /**
hgs
parents:
diff changeset
   141
     * Data to UI
hgs
parents:
diff changeset
   142
     */
hgs
parents:
diff changeset
   143
    TSatNotificationV1 iCloseChannelUiData;
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
    /**
hgs
parents:
diff changeset
   146
     * IPC Package to ui data
hgs
parents:
diff changeset
   147
     */
hgs
parents:
diff changeset
   148
    TSatNotificationV1Pckg iCloseChannelUiPckg;
hgs
parents:
diff changeset
   149
hgs
parents:
diff changeset
   150
    /**
hgs
parents:
diff changeset
   151
     * UI Response
hgs
parents:
diff changeset
   152
     */
hgs
parents:
diff changeset
   153
    TSatNotificationRspV1 iCloseChannelUiRsp;
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
    /**
hgs
parents:
diff changeset
   156
     * IPC Package to response
hgs
parents:
diff changeset
   157
     */
hgs
parents:
diff changeset
   158
    TSatNotificationRspV1Pckg iCloseChannelUiRspPckg;
hgs
parents:
diff changeset
   159
hgs
parents:
diff changeset
   160
    /**
hgs
parents:
diff changeset
   161
     * Flag to signal client response that handle command is not done
hgs
parents:
diff changeset
   162
     */
hgs
parents:
diff changeset
   163
    TBool iWaitHandleCloseCommand;
hgs
parents:
diff changeset
   164
hgs
parents:
diff changeset
   165
    /**
hgs
parents:
diff changeset
   166
     * Flag to signal that icon response is needed before terminal
hgs
parents:
diff changeset
   167
     * response is done
hgs
parents:
diff changeset
   168
     */
hgs
parents:
diff changeset
   169
    TBool iWaitClientIconResponse;
hgs
parents:
diff changeset
   170
        
hgs
parents:
diff changeset
   171
    /**
hgs
parents:
diff changeset
   172
     * Flag to signal that command has icon data
hgs
parents:
diff changeset
   173
     * To be removed when icons are allowed in this command
hgs
parents:
diff changeset
   174
     */
hgs
parents:
diff changeset
   175
    TBool iIconCommand;
hgs
parents:
diff changeset
   176
hgs
parents:
diff changeset
   177
    };
hgs
parents:
diff changeset
   178
hgs
parents:
diff changeset
   179
#endif      // CCLOSECHANNELHANDLER_H
hgs
parents:
diff changeset
   180