epoc32/include/mw/msenhostletresponse.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
--- a/epoc32/include/mw/msenhostletresponse.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/mw/msenhostletresponse.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,72 @@
-msenhostletresponse.h
+/*
+* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* 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
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: Hostlet response call back interface        
+*
+*/
+
+
+#ifndef MSEN_HOSTLET_RESPONSE_H
+#define MSEN_HOSTLET_RESPONSE_H
+
+#include <e32base.h>
+
+// FORWARD DECLARE
+class MSenProperties;
+class MSenMessage;
+
+
+class MSenHostletResponse
+    {
+    public:
+        /**
+        *  Set the response
+        * @param aResponseUtf8 is the response that this hostlet is providing
+        * @param aCode can be set to error code, in case that request is not
+        * accepted by this hostlet.
+        * @param aResponseProperties may be provided in order to pass (transport)
+        * properties with the response.
+        * @param aResponseMessage may be provided in order to pass concrete
+        * message object with the response (like libxml2 based SOAP-ENV,
+        * CSenSoapEnvelope2)
+        */
+        virtual void SetResponseUtf8L(const TDesC8& aResponseUtf8, 
+                                      const TInt aResponseCode = KErrNone, 
+                                      MSenProperties* aResponseProperties = NULL,
+                                      MSenMessage* apMessage = NULL) = 0;
+        
+        /**
+        * Getter for request (transaction) ID
+        * @return the id of the request to which this is a response for
+        */ 
+        virtual TInt RequestId() const = 0;
+        
+        /**
+        * Getter for response data
+        * @return the set response as UTF-8 descriptor
+        */
+        virtual TPtrC8 ResponseUtf8() = 0;
+
+        /**
+        * Getter for response code
+        * @return the response code (KErrNone or some error) that hostlet has provided
+        */
+        virtual TInt ResponseCode() const = 0;
+        
+        /**
+        * Getter for response properties
+        */
+        virtual MSenProperties* ResponseProperties() = 0;
+    };
+
+#endif // MSEN_HOSTLET_RESPONSE_H