epoc32/include/mw/msenhostletrequest.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h) This is the epoc32/include tree with the "platform" subtrees removed, and all but a selected few mbg and rsg files removed.

/*
* 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 "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: Hostlet request call back interface      
*
*/

#ifndef MSEN_HOSTLET_REQUEST_H
#define MSEN_HOSTLET_REQUEST_H

#include <e32base.h>

#include <MSenProperties.h>

// FORWARD DECLARATIONS
class CSenIdentifier;

class MSenHostletRequest
    {
    public:
        /**
        * Getter for the request - it may either be plain (SOAP) request body,
        * or complete request including all the (SOAP) headers, depending
        * of whether or not the provider wishes to receive complete client
        * messages.
        * @see MSenProvider for more information about complete client
        *      messages facet.
        */
        virtual TPtrC8 RequestUtf8() const = 0;

        /**
        * Getter for requester's thread ID
        */
        virtual TPtrC ThreadId() const = 0;

        /** 
        * Getter for requester's consumer ID
        */
        virtual TPtrC8 ConsumerId() const = 0;

        /** 
        * Getter for request ID (transaction ID)
        */
        virtual TInt RequestId() const = 0;
        
        /**
        * Getter for request's properties and properties type
        * @param aType provides the (class) type of the retuned properties.
        * This enum can be used to select corresponding properties class
        * to de-serialize the properties descriptor into a more convenient
        * properties class instance.
        * @return the (transport) properties associated with this message.
        */
        virtual TPtrC8 Properties(MSenProperties::TSenPropertiesClassType& aType) const = 0;

        //virtual const CSenIdentifier& Requester() const = 0;
    };

#endif // MSEN_HOSTLET_REQUEST_H