epoc32/include/mw/msenhostletrequest.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description: Hostlet request call back interface      
    15 *
    16 */
    17 
    18 #ifndef MSEN_HOSTLET_REQUEST_H
    19 #define MSEN_HOSTLET_REQUEST_H
    20 
    21 #include <e32base.h>
    22 
    23 #include <MSenProperties.h>
    24 
    25 // FORWARD DECLARATIONS
    26 class CSenIdentifier;
    27 
    28 class MSenHostletRequest
    29     {
    30     public:
    31         /**
    32         * Getter for the request - it may either be plain (SOAP) request body,
    33         * or complete request including all the (SOAP) headers, depending
    34         * of whether or not the provider wishes to receive complete client
    35         * messages.
    36         * @see MSenProvider for more information about complete client
    37         *      messages facet.
    38         */
    39         virtual TPtrC8 RequestUtf8() const = 0;
    40 
    41         /**
    42         * Getter for requester's thread ID
    43         */
    44         virtual TPtrC ThreadId() const = 0;
    45 
    46         /** 
    47         * Getter for requester's consumer ID
    48         */
    49         virtual TPtrC8 ConsumerId() const = 0;
    50 
    51         /** 
    52         * Getter for request ID (transaction ID)
    53         */
    54         virtual TInt RequestId() const = 0;
    55         
    56         /**
    57         * Getter for request's properties and properties type
    58         * @param aType provides the (class) type of the retuned properties.
    59         * This enum can be used to select corresponding properties class
    60         * to de-serialize the properties descriptor into a more convenient
    61         * properties class instance.
    62         * @return the (transport) properties associated with this message.
    63         */
    64         virtual TPtrC8 Properties(MSenProperties::TSenPropertiesClassType& aType) const = 0;
    65 
    66         //virtual const CSenIdentifier& Requester() const = 0;
    67     };
    68 
    69 #endif // MSEN_HOSTLET_REQUEST_H