appsupport_plat/oom_monitor_plugin_api/inc/oommonitorplugin.h
branchRCL_3
changeset 18 0818dd463d41
parent 1 0fdb7f6b0309
child 19 924385140d98
equal deleted inserted replaced
17:5e7d68cc22e0 18:0818dd463d41
     1 /*
     1 /*
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
     2 * Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies). 
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    76 	* cause a large increase in memory use, but that memory may be
    76 	* cause a large increase in memory use, but that memory may be
    77 	* used over time, otherwise the plugin may cause oscillation
    77 	* used over time, otherwise the plugin may cause oscillation
    78 	* between low and good memory states.
    78 	* between low and good memory states.
    79 	*/
    79 	*/
    80 	virtual void MemoryGood() = 0;
    80 	virtual void MemoryGood() = 0;
       
    81 	
       
    82     /**
       
    83     * Function: AppId
       
    84     * The function return the UID3 of the process which implements the plugin
       
    85     * By default, the Null UID [KNullUid] is returned. 
       
    86     * The plugin can override this API with their own implementation.
       
    87     * COomMonitorPlugin monitor plugins
       
    88     * @return the UID3 the application which implements the plugin
       
    89     */
       
    90 	virtual const TUid AppId() const;
    81 
    91 
    82 public:
    92 public:
    83     /**
    93     /**
    84     * Get a handle to the file server.
    94     * Get a handle to the file server.
    85     * @return a connected file server session.
    95     * @return a connected file server session.
   172 NONSHARABLE_CLASS(CAppOomMonitorPlugin) : public COomMonitorPlugin
   182 NONSHARABLE_CLASS(CAppOomMonitorPlugin) : public COomMonitorPlugin
   173     {
   183     {
   174 public:
   184 public:
   175     IMPORT_C static CAppOomMonitorPlugin* NewL(TUid aAppUid);
   185     IMPORT_C static CAppOomMonitorPlugin* NewL(TUid aAppUid);
   176     
   186     
       
   187     /**
       
   188     * Function: AppId
       
   189     * The function return the UID3 of the process which implements the plugin
       
   190     * By default, the Null UID [KNullUid] is returned. 
       
   191     * The plugin can override this API with their own implementation.
       
   192     * COomMonitorPlugin monitor plugins
       
   193     * @return the UID3 the application which implements the plugin
       
   194     */
       
   195     const TUid AppId() const;
       
   196     
   177 private:
   197 private:
   178 	CAppOomMonitorPlugin(TUid aAppUid);
   198 	CAppOomMonitorPlugin(TUid aAppUid);
   179 
   199 
   180 	void FreeRam();
   200 	void FreeRam();
   181 	void MemoryGood();
   201 	void MemoryGood();