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.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: Hostlet request call back interface      
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef MSEN_HOSTLET_REQUEST_H
williamr@2
    19
#define MSEN_HOSTLET_REQUEST_H
williamr@2
    20
williamr@2
    21
#include <e32base.h>
williamr@2
    22
williamr@2
    23
#include <MSenProperties.h>
williamr@2
    24
williamr@2
    25
// FORWARD DECLARATIONS
williamr@2
    26
class CSenIdentifier;
williamr@2
    27
williamr@2
    28
class MSenHostletRequest
williamr@2
    29
    {
williamr@2
    30
    public:
williamr@2
    31
        /**
williamr@2
    32
        * Getter for the request - it may either be plain (SOAP) request body,
williamr@2
    33
        * or complete request including all the (SOAP) headers, depending
williamr@2
    34
        * of whether or not the provider wishes to receive complete client
williamr@2
    35
        * messages.
williamr@2
    36
        * @see MSenProvider for more information about complete client
williamr@2
    37
        *      messages facet.
williamr@2
    38
        */
williamr@2
    39
        virtual TPtrC8 RequestUtf8() const = 0;
williamr@2
    40
williamr@2
    41
        /**
williamr@2
    42
        * Getter for requester's thread ID
williamr@2
    43
        */
williamr@2
    44
        virtual TPtrC ThreadId() const = 0;
williamr@2
    45
williamr@2
    46
        /** 
williamr@2
    47
        * Getter for requester's consumer ID
williamr@2
    48
        */
williamr@2
    49
        virtual TPtrC8 ConsumerId() const = 0;
williamr@2
    50
williamr@2
    51
        /** 
williamr@2
    52
        * Getter for request ID (transaction ID)
williamr@2
    53
        */
williamr@2
    54
        virtual TInt RequestId() const = 0;
williamr@2
    55
        
williamr@2
    56
        /**
williamr@2
    57
        * Getter for request's properties and properties type
williamr@2
    58
        * @param aType provides the (class) type of the retuned properties.
williamr@2
    59
        * This enum can be used to select corresponding properties class
williamr@2
    60
        * to de-serialize the properties descriptor into a more convenient
williamr@2
    61
        * properties class instance.
williamr@2
    62
        * @return the (transport) properties associated with this message.
williamr@2
    63
        */
williamr@2
    64
        virtual TPtrC8 Properties(MSenProperties::TSenPropertiesClassType& aType) const = 0;
williamr@2
    65
williamr@2
    66
        //virtual const CSenIdentifier& Requester() const = 0;
williamr@2
    67
    };
williamr@2
    68
williamr@2
    69
#endif // MSEN_HOSTLET_REQUEST_H