epoc32/include/http/rhttpresponse.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file RHTTPResponse.h
williamr@2
    20
 @warning : This file contains Rose Model ID comments - please do not delete
williamr@2
    21
*/
williamr@2
    22
williamr@2
    23
#ifndef __RHTTPRESPONSE_H__
williamr@2
    24
#define __RHTTPRESPONSE_H__
williamr@2
    25
williamr@2
    26
// System includes
williamr@2
    27
#include <e32std.h>
williamr@2
    28
#include <http/rhttpmessage.h>
williamr@2
    29
#include <stringpool.h>
williamr@2
    30
williamr@2
    31
williamr@2
    32
//##ModelId=3A375D1203B5
williamr@2
    33
class RHTTPResponse : public RHTTPMessage
williamr@2
    34
/** 
williamr@2
    35
An HTTP Response.  This class extends the abstract HTTP Message to add an HTTP
williamr@2
    36
version, a status code and status text.
williamr@2
    37
@publishedAll
williamr@2
    38
@released
williamr@2
    39
*/
williamr@2
    40
	{
williamr@2
    41
public:
williamr@2
    42
	/**Get Methods
williamr@2
    43
		Methods for reading information from the response.
williamr@2
    44
	*/
williamr@2
    45
	//@{
williamr@2
    46
	/** 
williamr@2
    47
		Returns the status code
williamr@2
    48
	*/
williamr@2
    49
	//##ModelId=3A914DF801B3
williamr@2
    50
	IMPORT_C TInt StatusCode() const;
williamr@2
    51
	/** Returns the status text, that is the text after the number on
williamr@2
    52
        the first line of the response. */
williamr@2
    53
	//##ModelId=3A914DF80195
williamr@2
    54
	IMPORT_C RStringF StatusText() const;
williamr@2
    55
	/**
williamr@2
    56
		Returns the version of HTTP used by the server
williamr@2
    57
	*/
williamr@2
    58
	//##ModelId=3A914DF80163
williamr@2
    59
	IMPORT_C TVersion Version() const;
williamr@2
    60
	//@}
williamr@2
    61
	/** Set Methods 
williamr@2
    62
williamr@2
    63
		Methods for setting information. These methods will not be of
williamr@2
    64
		use to the client; they are intended for the use of advanced
williamr@2
    65
		filters
williamr@2
    66
	*/
williamr@2
    67
	//@{
williamr@2
    68
	/** Sets the status code.
williamr@2
    69
	 */
williamr@2
    70
	//##ModelId=3A3765310382
williamr@2
    71
	IMPORT_C void SetStatusCode(TInt aStatus);
williamr@2
    72
	/// Sets the status string
williamr@2
    73
	//##ModelId=3A914DF8019F
williamr@2
    74
	IMPORT_C void SetStatusText(RStringF aStatusString);
williamr@2
    75
	/// Sets the HTTP version
williamr@2
    76
	//##ModelId=3A914DF8016D
williamr@2
    77
	IMPORT_C void SetVersion(TVersion aVersion);
williamr@2
    78
	//@}
williamr@2
    79
williamr@2
    80
	friend class CResponse;
williamr@2
    81
	};
williamr@2
    82
williamr@2
    83
williamr@2
    84
williamr@2
    85
#endif // __RHTTPRESPONSE_H__