1 /*

     2 * Copyright (c) 2003-2004 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:  Command Handler Negotiators.

    15 *

    16 */

    17 

    18 

    19 #ifndef MPHSRVCOMHANDNEGOTIATORS_H

    20 #define MPHSRVCOMHANDNEGOTIATORS_H

    21 

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 #include <CPhCltCommandHandler.h>

    26 

    27 // FORWARD DECLARATIONS

    28 class MPhSrvComHandInitiator;

    29 class MPhSrvComHandInitiatorStatus;

    30 class CPhSrvSubSessionBase;

    31 

    32 

    33 // CLASS DECLARATION

    34 

    35 

    36 /**

    37 *  Abstract command handler negotiators class.

    38 *

    39 *  @since 2.6

    40 */

    41 class MPhSrvComHandNegotiator

    42     {

    43     public: // New functions

    44 

    45         /**

    46         * Make a command handler request.

    47         *

    48         * @param aMessage Message to be negotiated.

    49         * @param aParams Request parameters.

    50         * @param aSubSession Subsession for command handler.

    51         */

    52         virtual void NegotiatorRequestL( 

    53             const RMessage2& aMessage, 

    54             const TPhCltComHandCommandParameters& aParams,

    55             CPhSrvSubSessionBase& aSubSession ) = 0;

    56 

    57         /**

    58         * Cancel's an oustanding command handler request. 

    59         * If the specified subsession doesn't have an oustanding request, 

    60         * then the subsession is panicked.

    61         *

    62         * @param aSubSession Subsession that has the command handler request.

    63         */

    64         virtual void NegotiatorRequestCancel( 

    65             CPhSrvSubSessionBase& aSubSession ) = 0;

    66 

    67         /**

    68         * Called by the command handler notifier subsession when it's ready 

    69         * to negotiate (perform another request) with the external interface.

    70         *

    71         * @param aInitiator Command handler initiator instance.

    72         */

    73         virtual void SetNegotiatorReadyRequestL( 

    74             MPhSrvComHandInitiator& aInitiator ) = 0;

    75 

    76         /**

    77         * Called by the command handler notifier subsession when it isn't going

    78         * to be available to make further requests (session has closed)

    79         *

    80         * @param aInitiator Command handler initiator instance.

    81         */

    82         virtual void SetNegotiatorReadyRequestCancel( 

    83             MPhSrvComHandInitiator& aInitiator ) = 0;

    84 

    85         /**

    86         * Called by the command handler notifier subsession when it's attempted

    87         * to perform a request - the command handler negotiator can then inform

    88         * the external command handler interface of the result.

    89         *

    90         * @param aResult Result of the request perfom.

    91         */

    92         virtual void SetNegotiatorAttemptedRequestResponseValue( 

    93             TPhCltPhoneResults aResult ) = 0;

    94     };

    95 

    96 #endif // MPHSRVCOMHANDNEGOTIATORS_H

    97 

    98 

    99 // End of File