epoc32/include/mw/http/rhttpresponse.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 RHTTPResponse.h
    18  @warning : This file contains Rose Model ID comments - please do not delete
    19 */
    20 
    21 #ifndef __RHTTPRESPONSE_H__
    22 #define __RHTTPRESPONSE_H__
    23 
    24 // System includes
    25 #include <e32std.h>
    26 #include <http/rhttpmessage.h>
    27 #include <stringpool.h>
    28 
    29 
    30 //##ModelId=3A375D1203B5
    31 class RHTTPResponse : public RHTTPMessage
    32 /** 
    33 An HTTP Response.  This class extends the abstract HTTP Message to add an HTTP
    34 version, a status code and status text.
    35 @publishedAll
    36 @released
    37 */
    38 	{
    39 public:
    40 	/**Get Methods
    41 		Methods for reading information from the response.
    42 	*/
    43 	//@{
    44 	/** 
    45 		Returns the status code
    46 	*/
    47 	//##ModelId=3A914DF801B3
    48 	IMPORT_C TInt StatusCode() const;
    49 	/** Returns the status text, that is the text after the number on
    50         the first line of the response. */
    51 	//##ModelId=3A914DF80195
    52 	IMPORT_C RStringF StatusText() const;
    53 	/**
    54 		Returns the version of HTTP used by the server
    55 	*/
    56 	//##ModelId=3A914DF80163
    57 	IMPORT_C TVersion Version() const;
    58 	//@}
    59 	/** Set Methods 
    60 
    61 		Methods for setting information. These methods will not be of
    62 		use to the client; they are intended for the use of advanced
    63 		filters
    64 	*/
    65 	//@{
    66 	/** Sets the status code.
    67 	 */
    68 	//##ModelId=3A3765310382
    69 	IMPORT_C void SetStatusCode(TInt aStatus);
    70 	// Sets the status string
    71 	//##ModelId=3A914DF8019F
    72 	IMPORT_C void SetStatusText(RStringF aStatusString);
    73 	// Sets the HTTP version
    74 	//##ModelId=3A914DF8016D
    75 	IMPORT_C void SetVersion(TVersion aVersion);
    76 	//@}
    77 
    78 	friend class CResponse;
    79 	};
    80 
    81 
    82 
    83 #endif // __RHTTPRESPONSE_H__