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