epoc32/include/mw/http/rhttppropertyset.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/http/rhttppropertyset.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,86 @@
     1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +
    1.20 +
    1.21 +/**
    1.22 + @file RHTTPPropertySet.h
    1.23 + @warning : This file contains Rose Model ID comments - please do not delete
    1.24 +*/
    1.25 +
    1.26 +#ifndef __RHTTPPROPERTYSET_H__
    1.27 +#define __RHTTPPROPERTYSET_H__ 
    1.28 +
    1.29 +// System includes
    1.30 +#include <http/thttphdrval.h> 
    1.31 +
    1.32 +// Forward declarations
    1.33 +class CHeaderFieldPart;
    1.34 +
    1.35 +
    1.36 +//##ModelId=3C4C188201EA
    1.37 +class RHTTPPropertySet
    1.38 +/** 
    1.39 +A set of named THTTPHdrVal objects. Used for storing arbitrary
    1.40 +collections of information.  
    1.41 +@publishedAll
    1.42 +@released
    1.43 +*/
    1.44 +	{
    1.45 + public:
    1.46 +	/** Default (uninitialised) constructor. An object constructed in this way
    1.47 +		means 'use text-mode HTTP with default settings'
    1.48 +	 */
    1.49 +	//##ModelId=3A63217800E0
    1.50 +	IMPORT_C RHTTPPropertySet();
    1.51 +	
    1.52 +	/** Returns a property.
    1.53 +		@param aPropertyName The name of the property.
    1.54 +		@param aVal The returned value of the property (if defined)
    1.55 +		@return ETrue if the property exists
    1.56 +	*/
    1.57 +	//##ModelId=3C4C1882021F
    1.58 +	IMPORT_C TBool Property(RStringF aPropertyName, THTTPHdrVal& aVal) const;
    1.59 +
    1.60 +	/** Sets or creates a property. 
    1.61 +		@param aPropertyName The name of the property
    1.62 +		@param aValue The new value of the property
    1.63 +		@leave KErrNoMemory There was not enough memory.
    1.64 +	 */
    1.65 +	//##ModelId=3C4C1882021C
    1.66 +	IMPORT_C void SetPropertyL(RStringF aPropertyName, THTTPHdrVal aValue);
    1.67 +
    1.68 +	/** Removes a named property. 
    1.69 +		@param aPropertyName The name of the property
    1.70 +	 */
    1.71 +	//##ModelId=3C4C18820213
    1.72 +	IMPORT_C void RemoveProperty(RStringF aPropertyName);
    1.73 +
    1.74 +	/** Removes all properties
    1.75 +	 */
    1.76 +	//##ModelId=3C4C18820212
    1.77 +	IMPORT_C void RemoveAllProperties();
    1.78 +
    1.79 + protected:
    1.80 +	//##ModelId=3C4C18820208
    1.81 +	CHeaderFieldPart* iImplementation;
    1.82 +
    1.83 +	friend class CHeaderFieldPart;
    1.84 +	friend class CHTTPSession;
    1.85 +	};
    1.86 +
    1.87 +
    1.88 +
    1.89 +#endif //	__RHTTPPROPERTYSET_H__