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.
williamr@2
     1
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
/**
williamr@4
    17
 @file
williamr@2
    18
 @warning : This file contains Rose Model ID comments - please do not delete
williamr@2
    19
*/
williamr@2
    20
williamr@2
    21
#ifndef __RHTTPPROPERTYSET_H__
williamr@2
    22
#define __RHTTPPROPERTYSET_H__ 
williamr@2
    23
williamr@2
    24
// System includes
williamr@2
    25
#include <http/thttphdrval.h> 
williamr@2
    26
williamr@2
    27
// Forward declarations
williamr@2
    28
class CHeaderFieldPart;
williamr@2
    29
williamr@2
    30
williamr@2
    31
//##ModelId=3C4C188201EA
williamr@2
    32
class RHTTPPropertySet
williamr@2
    33
/** 
williamr@2
    34
A set of named THTTPHdrVal objects. Used for storing arbitrary
williamr@2
    35
collections of information.  
williamr@2
    36
@publishedAll
williamr@2
    37
@released
williamr@2
    38
*/
williamr@2
    39
	{
williamr@2
    40
 public:
williamr@2
    41
	/** Default (uninitialised) constructor. An object constructed in this way
williamr@2
    42
		means 'use text-mode HTTP with default settings'
williamr@2
    43
	 */
williamr@2
    44
	//##ModelId=3A63217800E0
williamr@2
    45
	IMPORT_C RHTTPPropertySet();
williamr@2
    46
	
williamr@2
    47
	/** Returns a property.
williamr@2
    48
		@param aPropertyName The name of the property.
williamr@2
    49
		@param aVal The returned value of the property (if defined)
williamr@2
    50
		@return ETrue if the property exists
williamr@2
    51
	*/
williamr@2
    52
	//##ModelId=3C4C1882021F
williamr@2
    53
	IMPORT_C TBool Property(RStringF aPropertyName, THTTPHdrVal& aVal) const;
williamr@2
    54
williamr@2
    55
	/** Sets or creates a property. 
williamr@2
    56
		@param aPropertyName The name of the property
williamr@2
    57
		@param aValue The new value of the property
williamr@2
    58
		@leave KErrNoMemory There was not enough memory.
williamr@2
    59
	 */
williamr@2
    60
	//##ModelId=3C4C1882021C
williamr@2
    61
	IMPORT_C void SetPropertyL(RStringF aPropertyName, THTTPHdrVal aValue);
williamr@4
    62
	
williamr@4
    63
	IMPORT_C TInt SetProperty(RStringF aPropertyName, THTTPHdrVal aValue);
williamr@2
    64
	/** Removes a named property. 
williamr@2
    65
		@param aPropertyName The name of the property
williamr@2
    66
	 */
williamr@2
    67
	//##ModelId=3C4C18820213
williamr@2
    68
	IMPORT_C void RemoveProperty(RStringF aPropertyName);
williamr@2
    69
williamr@2
    70
	/** Removes all properties
williamr@2
    71
	 */
williamr@2
    72
	//##ModelId=3C4C18820212
williamr@2
    73
	IMPORT_C void RemoveAllProperties();
williamr@2
    74
williamr@2
    75
 protected:
williamr@2
    76
	//##ModelId=3C4C18820208
williamr@2
    77
	CHeaderFieldPart* iImplementation;
williamr@2
    78
williamr@2
    79
	friend class CHeaderFieldPart;
williamr@2
    80
	friend class CHTTPSession;
williamr@2
    81
	};
williamr@2
    82
williamr@2
    83
williamr@2
    84
williamr@2
    85
#endif //	__RHTTPPROPERTYSET_H__