fotaapplication/fotacustcmds/inc/fotacustcmdfirmwareupdate.h
author hgs
Tue, 13 Jul 2010 09:51:41 +0530
changeset 51 2e64dc50f295
permissions -rw-r--r--
201025_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     1
/*
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     3
* All rights reserved.
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     8
*
2e64dc50f295 201025_02
hgs
parents:
diff changeset
     9
* Initial Contributors:
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    11
*
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    12
* Contributors:
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    13
*
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    14
* Description:
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    15
* Declaration of CFotaCustCmdFirmwareUpdate class.
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    16
*
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    17
*/
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    18
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    19
#ifndef FOTACUSTCMDFIRMWAREUPDATE_H
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    20
#define FOTACUSTCMDFIRMWAREUPDATE_H
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    21
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    22
#include <e32base.h>
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    23
#include <ssm/ssmcustomcommand.h>
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    24
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    25
/**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    26
 *  Each command is implemented in a class derived from MSsmCustomCommand.
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    27
 *  It is also possible to implement multiple similar command in the same
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    28
 *  class and differentiate between them based on constructor parameters
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    29
 *  from the factory method.
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    30
 */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    31
NONSHARABLE_CLASS( CFotaCustCmdFirmwareUpdate ) : public CBase, public MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    32
    {
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    33
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    34
public:
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    35
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    36
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    37
     * Two-phased constructor
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    38
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    39
	static CFotaCustCmdFirmwareUpdate* NewL();
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    40
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    41
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    42
     * Destructor
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    43
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    44
    virtual ~CFotaCustCmdFirmwareUpdate();
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    45
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    46
private: // From MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    47
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    48
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    49
     * @see MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    50
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    51
    TInt Initialize( CSsmCustomCommandEnv* aCmdEnv );
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    52
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    53
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    54
     * @see MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    55
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    56
	void Execute( const TDesC8& aParams, TRequestStatus& aRequest );
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    57
	
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    58
	  /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    59
     * invokes fotaengine after fota update
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    60
     * @Params None
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    61
     * @return  None
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    62
     *
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    63
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    64
	void ExecuteL();
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    65
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    66
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    67
     * @see MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    68
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    69
	void ExecuteCancel();
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    70
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    71
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    72
     * @see MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    73
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    74
	void Close();
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    75
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    76
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    77
     * @see MSsmCustomCommand
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    78
     */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    79
	void Release();
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    80
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    81
private: // data
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    82
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    83
    /**
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    84
    * If the command needs command env in Execute function, it should store it
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    85
    * to member variable:
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    86
    *
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    87
    * Custom command environment. Not owned. Set in Initialize.
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    88
    * CSsmCustomCommandEnv* iEnv;
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    89
    */
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    90
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    91
    };
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    92
2e64dc50f295 201025_02
hgs
parents:
diff changeset
    93
#endif // FOTACUSTCMDFIRMWAREUPDATE_H