1 /*

     2 * Copyright (c) 2008 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:  Interface for active object wrapper

    15 *

    16 */

    17 

    18 

    19 #ifndef MSATASYNCTOSYNC_H

    20 #define MSATASYNCTOSYNC_H

    21 

    22 

    23 #include <e32base.h>

    24 

    25 /**

    26  *  Active object wrapper for SAT Server

    27  *  Interface provides asynchronous function calls to be synchronous functions.

    28  *

    29  *  @lib satengine.lib

    30  *  @since S60 v5.0.1

    31  */

    32 class MSatAsyncToSync

    33     {

    34 

    35 public:

    36 

    37     /**

    38      * Gives reference to this active object wrapper's request status. Use this 

    39      * when calling asynchronous function and you want to use this wrapper.

    40      *

    41      * @return  Request status to be sent to asynchronous function call

    42      */

    43     virtual TRequestStatus& RequestStatus() = 0;

    44     

    45     /**

    46      * Sets this wrapper active and starts waiting for request to complete.

    47      * Function returns after request status given to asynchronous funtion with 

    48      * RequestStatus is completed or wrapper is cancelled.

    49      *

    50      * @return System-wide error code indicating the completion of request

    51      */

    52     virtual TInt SetActiveAndWait() = 0;

    53 

    54     /**

    55      * Cancels request status or timer depending which is active

    56      */

    57     virtual void CancelWrapper() = 0;

    58 

    59     /**

    60      * Release object

    61      */

    62     virtual void Release() = 0;

    63    };

    64 

    65 #endif // MSATASYNCTOSYNC_H