appsupport_plat/oom_monitor_api/inc/oommonitorsession.h
branchRCL_3
changeset 19 924385140d98
parent 1 0fdb7f6b0309
child 20 c2c61fdca848
equal deleted inserted replaced
18:0818dd463d41 19:924385140d98
     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".
    66     * @return KErrNone if successful, error code otherwise.
    66     * @return KErrNone if successful, error code otherwise.
    67     */
    67     */
    68     IMPORT_C TInt Connect();
    68     IMPORT_C TInt Connect();
    69 
    69 
    70     /**
    70     /**
    71     * Request that the OOM monitor attempts to free some memory.
    71     * Request that the OOM monitor attempts to free some paged memory.
    72     * This function may take several seconds to execute, depending on
    72     * This function may take several seconds to execute, depending on
    73     * the memory state. It will not return until the attempt to recover
    73     * the memory state. It will not return until the attempt to recover
    74     * memory has completed.
    74     * memory has completed.
    75     * @param aBytesRequested The number of bytes of free memory that the client requests.
    75     * @param aBytesRequested The number of bytes of free memory that the client requests.
    76     * @return KErrNone if the request memory is free. KErrNoMemory if that
    76     * @return KErrNone if the request memory is free. KErrNoMemory if that
    78     *         also be returned.
    78     *         also be returned.
    79     */
    79     */
    80     IMPORT_C TInt RequestFreeMemory(TInt aBytesRequested);
    80     IMPORT_C TInt RequestFreeMemory(TInt aBytesRequested);
    81 
    81 
    82     /**
    82     /**
    83     * Request that the OOM monitor attempts to free some memory.
    83     * Request that the OOM monitor attempts to free some paged memory.
    84     * This is an asynchronous version of the request for free memory.
    84     * This is an asynchronous version of the request for free paged memory.
    85     * @param aBytesRequested The number of bytes of free memory that the client requests.
    85     * @param aBytesRequested The number of bytes of free memory that the client requests.
    86     * @param aStatus will be completed when the attempt to recover memory
    86     * @param aStatus will be completed when the attempt to recover memory
    87     *        has finished. This may take several seconds, depending on
    87     *        has finished. This may take several seconds, depending on
    88     *        the memory state. On completion, aStatus will be set to 
    88     *        the memory state. On completion, aStatus will be set to 
    89     *        KErrNone if the request memory is free. KErrNoMemory if that
    89     *        KErrNone if the request memory is free. KErrNoMemory if that