epoc32/include/mw/http/rhttptransactionpropertyset.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
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.
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 /**
    17  @file
    18  @warning : This file contains Rose Model ID comments - please do not delete
    19 */
    20 
    21 #ifndef __RHTTPTRANSACTIONPROPERTYSET_H__
    22 #define __RHTTPTRANSACTIONPROPERTYSET_H__ 
    23 
    24 // System includes
    25 #include <http/rhttppropertyset.h>
    26 
    27 
    28 //##ModelId=3B1E670402C2
    29 class RHTTPTransactionPropertySet : public RHTTPPropertySet
    30 /** 
    31 The set of properties of a transaction. This is used by filters to
    32 store per-transaction information, and is also used by the client
    33 to specify transaction properties (such as no caching, reload and
    34 so on) 
    35 
    36 Transaction properties always take precendence over session properties.
    37 
    38 To lookup/change any of the following properties, use 
    39 RHTTPPropertySet::Property(...) and RHTTPPropertySet::SetPropertyL(...) 
    40 
    41 To remove properties, use RHTTPPropertySet::RemoveProperty(...) for a named property,
    42 or RHTTPPropertySet::RemoveAllProperties() for all.
    43 
    44 
    45 The following values are currently defined.
    46 
    47 HTTP::EProxyUsage (HTTP::EDoNotUseProxy | HTTP::EUseProxy)
    48 
    49 HTTP::EProxyAddress (A Uri for the Proxy server. Should include the port number
    50 if it is not the default of 8080)
    51 
    52 HTTP::EHttpPipelining (default HTTP::EEnablePipelining) (HTTP::EEnablePipelining | HTTP::EDisablePipelining)
    53 @publishedAll
    54 @released
    55 */
    56 	{
    57 	};
    58 
    59 #endif //	__RHTTPTRANSACTIONPROPERTYSET_H__