epoc32/include/mw/http/rhttppropertyset.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 __RHTTPPROPERTYSET_H__
    22 #define __RHTTPPROPERTYSET_H__ 
    23 
    24 // System includes
    25 #include <http/thttphdrval.h> 
    26 
    27 // Forward declarations
    28 class CHeaderFieldPart;
    29 
    30 
    31 //##ModelId=3C4C188201EA
    32 class RHTTPPropertySet
    33 /** 
    34 A set of named THTTPHdrVal objects. Used for storing arbitrary
    35 collections of information.  
    36 @publishedAll
    37 @released
    38 */
    39 	{
    40  public:
    41 	/** Default (uninitialised) constructor. An object constructed in this way
    42 		means 'use text-mode HTTP with default settings'
    43 	 */
    44 	//##ModelId=3A63217800E0
    45 	IMPORT_C RHTTPPropertySet();
    46 	
    47 	/** Returns a property.
    48 		@param aPropertyName The name of the property.
    49 		@param aVal The returned value of the property (if defined)
    50 		@return ETrue if the property exists
    51 	*/
    52 	//##ModelId=3C4C1882021F
    53 	IMPORT_C TBool Property(RStringF aPropertyName, THTTPHdrVal& aVal) const;
    54 
    55 	/** Sets or creates a property. 
    56 		@param aPropertyName The name of the property
    57 		@param aValue The new value of the property
    58 		@leave KErrNoMemory There was not enough memory.
    59 	 */
    60 	//##ModelId=3C4C1882021C
    61 	IMPORT_C void SetPropertyL(RStringF aPropertyName, THTTPHdrVal aValue);
    62 	
    63 	IMPORT_C TInt SetProperty(RStringF aPropertyName, THTTPHdrVal aValue);
    64 	/** Removes a named property. 
    65 		@param aPropertyName The name of the property
    66 	 */
    67 	//##ModelId=3C4C18820213
    68 	IMPORT_C void RemoveProperty(RStringF aPropertyName);
    69 
    70 	/** Removes all properties
    71 	 */
    72 	//##ModelId=3C4C18820212
    73 	IMPORT_C void RemoveAllProperties();
    74 
    75  protected:
    76 	//##ModelId=3C4C18820208
    77 	CHeaderFieldPart* iImplementation;
    78 
    79 	friend class CHeaderFieldPart;
    80 	friend class CHTTPSession;
    81 	};
    82 
    83 
    84 
    85 #endif //	__RHTTPPROPERTYSET_H__