hti/HtiServicePlugins/HtiStifTfServicePlugin/inc/HtiStifTfServicePlugin.h
changeset 36 813b186005b6
parent 30 86a2e675b80a
child 41 838cdffd57ce
equal deleted inserted replaced
30:86a2e675b80a 36:813b186005b6
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Defines the ECom plugin for HTI STIF Test Framework control
       
    15 *                service.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef HTISTIFTFSERVICEPLUGIN_H
       
    22 #define HTISTIFTFSERVICEPLUGIN_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include <HtiServicePluginInterface.h>
       
    26 
       
    27 // CONSTANTS
       
    28 
       
    29 // MACROS
       
    30 
       
    31 // DATA TYPES
       
    32 
       
    33 // FUNCTION PROTOTYPES
       
    34 
       
    35 // FORWARD DECLARATIONS
       
    36 class CHtiStifTfIf;
       
    37 
       
    38 // CLASS DECLARATION
       
    39 
       
    40 /**
       
    41 *  The ECom plugin for HTI STIF Test Framework control service.
       
    42 *
       
    43 */
       
    44 class CHtiStifTfServicePlugin : public CHTIServicePluginInterface
       
    45     {
       
    46     public:  // Constructors and destructor
       
    47 
       
    48         /**
       
    49         * Two-phased constructor.
       
    50         */
       
    51         static CHtiStifTfServicePlugin* NewL();
       
    52 
       
    53     public: // New functions
       
    54 
       
    55     public: // Functions from base classes
       
    56 
       
    57         /**
       
    58         * From CHTIServicePluginInterface
       
    59         * Called by the HTI Framework when sending message to this service.
       
    60         * @param aMessage message body destinated to a servive
       
    61         * @param aPriority message priority
       
    62         */
       
    63         void ProcessMessageL( const TDesC8& aMessage,
       
    64             THtiMessagePriority aPriority );
       
    65 
       
    66         /**
       
    67         * From CHTIServicePluginInterface
       
    68         * Called by HTI Framework to tell the service how much memory is
       
    69         * available for messages in the message queue.
       
    70         * @param aAvailableMemory amount of currently available memory
       
    71         *        in the message queue
       
    72         */
       
    73         void NotifyMemoryChange( TInt aAvailableMemory );
       
    74 
       
    75         /**
       
    76         * From CHTIServicePluginInterface
       
    77         * Indicates to HTI Framework whether the plugin is ready to process
       
    78         * a new message or if it's busy processing previous message.
       
    79         */
       
    80         TBool IsBusy();
       
    81 
       
    82     protected:  // New functions
       
    83 
       
    84         /**
       
    85         * C++ default constructor.
       
    86         */
       
    87         CHtiStifTfServicePlugin();
       
    88 
       
    89         /**
       
    90         * 2nd phase constructor.
       
    91         */
       
    92         void ConstructL();
       
    93 
       
    94         /**
       
    95         * Destructor.
       
    96         */
       
    97         virtual ~CHtiStifTfServicePlugin();
       
    98 
       
    99 
       
   100     protected:  // Functions from base classes
       
   101 
       
   102     private:
       
   103 
       
   104 
       
   105     public:     // Data
       
   106 
       
   107     protected:  // Data
       
   108 
       
   109     private:    // Data
       
   110 
       
   111         // Instance of the class derived from CStifTFwIf
       
   112         CHtiStifTfIf* iStifTfInterface;
       
   113 
       
   114     public:     // Friend classes
       
   115 
       
   116     protected:  // Friend classes
       
   117 
       
   118     private:    // Friend classes
       
   119 
       
   120 
       
   121     };
       
   122 
       
   123 #endif      // HTISTIFTFSERVICEPLUGIN_H
       
   124 
       
   125 // End of File