1 /*

     2 * Copyright (c) 2002-2005 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: Hostlet response call back interface        

    15 *

    16 */

    17 

    18 

    19 #ifndef MSEN_HOSTLET_RESPONSE_H

    20 #define MSEN_HOSTLET_RESPONSE_H

    21 

    22 #include <e32base.h>

    23 

    24 // FORWARD DECLARE

    25 class MSenProperties;

    26 class MSenMessage;

    27 

    28 

    29 class MSenHostletResponse

    30     {

    31     public:

    32         /**

    33         *  Set the response

    34         * @param aResponseUtf8 is the response that this hostlet is providing

    35         * @param aCode can be set to error code, in case that request is not

    36         * accepted by this hostlet.

    37         * @param aResponseProperties may be provided in order to pass (transport)

    38         * properties with the response.

    39         * @param aResponseMessage may be provided in order to pass concrete

    40         * message object with the response (like libxml2 based SOAP-ENV,

    41         * CSenSoapEnvelope2)

    42         */

    43         virtual void SetResponseUtf8L(const TDesC8& aResponseUtf8, 

    44                                       const TInt aResponseCode = KErrNone, 

    45                                       MSenProperties* aResponseProperties = NULL,

    46                                       MSenMessage* apMessage = NULL) = 0;

    47         

    48         /**

    49         * Getter for request (transaction) ID

    50         * @return the id of the request to which this is a response for

    51         */ 

    52         virtual TInt RequestId() const = 0;

    53         

    54         /**

    55         * Getter for response data

    56         * @return the set response as UTF-8 descriptor

    57         */

    58         virtual TPtrC8 ResponseUtf8() = 0;

    59 

    60         /**

    61         * Getter for response code

    62         * @return the response code (KErrNone or some error) that hostlet has provided

    63         */

    64         virtual TInt ResponseCode() const = 0;

    65         

    66         /**

    67         * Getter for response properties

    68         */

    69         virtual MSenProperties* ResponseProperties() = 0;

    70     };

    71 

    72 #endif // MSEN_HOSTLET_RESPONSE_H