1.1 --- a/epoc32/include/mw/msenhostletresponse.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/msenhostletresponse.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,72 @@
1.4 -msenhostletresponse.h
1.5 +/*
1.6 +* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Hostlet response call back interface
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef MSEN_HOSTLET_RESPONSE_H
1.24 +#define MSEN_HOSTLET_RESPONSE_H
1.25 +
1.26 +#include <e32base.h>
1.27 +
1.28 +// FORWARD DECLARE
1.29 +class MSenProperties;
1.30 +class MSenMessage;
1.31 +
1.32 +
1.33 +class MSenHostletResponse
1.34 + {
1.35 + public:
1.36 + /**
1.37 + * Set the response
1.38 + * @param aResponseUtf8 is the response that this hostlet is providing
1.39 + * @param aCode can be set to error code, in case that request is not
1.40 + * accepted by this hostlet.
1.41 + * @param aResponseProperties may be provided in order to pass (transport)
1.42 + * properties with the response.
1.43 + * @param aResponseMessage may be provided in order to pass concrete
1.44 + * message object with the response (like libxml2 based SOAP-ENV,
1.45 + * CSenSoapEnvelope2)
1.46 + */
1.47 + virtual void SetResponseUtf8L(const TDesC8& aResponseUtf8,
1.48 + const TInt aResponseCode = KErrNone,
1.49 + MSenProperties* aResponseProperties = NULL,
1.50 + MSenMessage* apMessage = NULL) = 0;
1.51 +
1.52 + /**
1.53 + * Getter for request (transaction) ID
1.54 + * @return the id of the request to which this is a response for
1.55 + */
1.56 + virtual TInt RequestId() const = 0;
1.57 +
1.58 + /**
1.59 + * Getter for response data
1.60 + * @return the set response as UTF-8 descriptor
1.61 + */
1.62 + virtual TPtrC8 ResponseUtf8() = 0;
1.63 +
1.64 + /**
1.65 + * Getter for response code
1.66 + * @return the response code (KErrNone or some error) that hostlet has provided
1.67 + */
1.68 + virtual TInt ResponseCode() const = 0;
1.69 +
1.70 + /**
1.71 + * Getter for response properties
1.72 + */
1.73 + virtual MSenProperties* ResponseProperties() = 0;
1.74 + };
1.75 +
1.76 +#endif // MSEN_HOSTLET_RESPONSE_H