epoc32/include/mw/http/rhttprequest.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 __RHTTPREQUEST_H__
williamr@2
    22
#define __RHTTPREQUEST_H__ 
williamr@2
    23
williamr@2
    24
// System includes
williamr@2
    25
#include <uri8.h>
williamr@2
    26
#include <stringpool.h>
williamr@2
    27
#include <http/rhttpmessage.h>
williamr@2
    28
williamr@2
    29
williamr@2
    30
//##ModelId=3C4C186E0191
williamr@2
    31
class RHTTPRequest : public RHTTPMessage
williamr@2
    32
/** 
williamr@2
    33
An HTTP Request.  This class extends the abstract HTTP Message to add an HTTP
williamr@2
    34
method to be invoked on the resource at the remote HTTP server, and the URL that
williamr@2
    35
identifies that resource.
williamr@2
    36
@publishedAll
williamr@2
    37
@released
williamr@2
    38
*/
williamr@2
    39
	{
williamr@2
    40
 public:
williamr@2
    41
	/** Get Methods
williamr@2
    42
		Methods for reading information from the response.
williamr@2
    43
	*/
williamr@2
    44
	//@{
williamr@4
    45
	// Gets the method name
williamr@4
    46
	// @return The method to be used in the HTTP request.
williamr@2
    47
	//##ModelId=3C4C186E01B3
williamr@2
    48
	IMPORT_C RStringF Method() const;
williamr@4
    49
	// Gets the URI
williamr@4
    50
	// @return The URI to be used in the HTTP request.
williamr@2
    51
	//##ModelId=3C4C186E01B2
williamr@2
    52
	IMPORT_C const TUriC8& URI() const;
williamr@2
    53
	//@}
williamr@2
    54
	/**Set Methods
williamr@2
    55
		
williamr@2
    56
		Methods for setting information. These methods will not be of
williamr@2
    57
		use to the client; they are intended for the use of advanced
williamr@2
    58
		filters
williamr@2
    59
	*/
williamr@2
    60
	//@{
williamr@4
    61
	// Sets the method name
williamr@4
    62
	// @param aMethod The method name to be used in the HTTP request.
williamr@2
    63
	//##ModelId=3C4C186E01B0
williamr@2
    64
	IMPORT_C void  SetMethod(RStringF aMethod);
williamr@4
    65
	// Sets the URI
williamr@4
    66
	// @param aURI The URI to be used in the HTTP request.
williamr@2
    67
	//##ModelId=3C4C186E01A6
williamr@2
    68
	IMPORT_C void SetURIL(const TUriC8& aURI);
williamr@2
    69
	//@}
williamr@2
    70
williamr@2
    71
	friend class CRequest;
williamr@2
    72
	};
williamr@2
    73
williamr@2
    74
williamr@2
    75
#endif //	__RHTTPREQUEST_H__