epoc32/include/mw/http/rhttppropertyset.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/http/rhttppropertyset.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file RHTTPPropertySet.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef __RHTTPPROPERTYSET_H__
    24 #define __RHTTPPROPERTYSET_H__ 
    25 
    26 // System includes
    27 #include <http/thttphdrval.h> 
    28 
    29 // Forward declarations
    30 class CHeaderFieldPart;
    31 
    32 
    33 //##ModelId=3C4C188201EA
    34 class RHTTPPropertySet
    35 /** 
    36 A set of named THTTPHdrVal objects. Used for storing arbitrary
    37 collections of information.  
    38 @publishedAll
    39 @released
    40 */
    41 	{
    42  public:
    43 	/** Default (uninitialised) constructor. An object constructed in this way
    44 		means 'use text-mode HTTP with default settings'
    45 	 */
    46 	//##ModelId=3A63217800E0
    47 	IMPORT_C RHTTPPropertySet();
    48 	
    49 	/** Returns a property.
    50 		@param aPropertyName The name of the property.
    51 		@param aVal The returned value of the property (if defined)
    52 		@return ETrue if the property exists
    53 	*/
    54 	//##ModelId=3C4C1882021F
    55 	IMPORT_C TBool Property(RStringF aPropertyName, THTTPHdrVal& aVal) const;
    56 
    57 	/** Sets or creates a property. 
    58 		@param aPropertyName The name of the property
    59 		@param aValue The new value of the property
    60 		@leave KErrNoMemory There was not enough memory.
    61 	 */
    62 	//##ModelId=3C4C1882021C
    63 	IMPORT_C void SetPropertyL(RStringF aPropertyName, THTTPHdrVal aValue);
    64 
    65 	/** Removes a named property. 
    66 		@param aPropertyName The name of the property
    67 	 */
    68 	//##ModelId=3C4C18820213
    69 	IMPORT_C void RemoveProperty(RStringF aPropertyName);
    70 
    71 	/** Removes all properties
    72 	 */
    73 	//##ModelId=3C4C18820212
    74 	IMPORT_C void RemoveAllProperties();
    75 
    76  protected:
    77 	//##ModelId=3C4C18820208
    78 	CHeaderFieldPart* iImplementation;
    79 
    80 	friend class CHeaderFieldPart;
    81 	friend class CHTTPSession;
    82 	};
    83 
    84 
    85 
    86 #endif //	__RHTTPPROPERTYSET_H__