epoc32/include/http/mhttpdataoptimiser.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2007-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 mhttpoptimisercallback.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	__MHTTPDATAOPTIMISER_H__
williamr@2
    24
#define	__MHTTPDATAOPTIMISER_H__
williamr@2
    25
williamr@2
    26
williamr@2
    27
//@publishedPartner
williamr@2
    28
//@released
williamr@2
    29
class MHttpDataOptimiser
williamr@2
    30
{
williamr@2
    31
	public:
williamr@2
    32
	/**
williamr@2
    33
	This method converts the HTTP message data to the proprietary protocol format. 
williamr@2
    34
	It is the responsibility of the implementation to allocate the required buffer for the encoded data. 
williamr@2
    35
	It is the responsibility of the caller to free the allocated memory.
williamr@2
    36
	@param	aHTTPData Contains the message data in HTTP format.
williamr@2
    37
	@param	aEncodedData On return it contains the encoded message data.
williamr@2
    38
	@leave		KErrNoMemory On insuffcient memory conditions.
williamr@2
    39
	*/
williamr@2
    40
	virtual void EncodeL (const TDesC8& aHttpData, HBufC8*& aEncodedData) = 0;
williamr@2
    41
williamr@2
    42
	/**
williamr@2
    43
	This method converts the data from the proprietary protocol format to the HTTP format. 
williamr@2
    44
	It is the responsibility of the implementation to allocate the required buffer for the encoded data. 
williamr@2
    45
	It is the responsibility of the caller to free the allocated memory.
williamr@2
    46
	@param	aData Is the raw data received over the TCP connection.
williamr@2
    47
	@param	aHTTPData On return contains the data in HTTP format.
williamr@2
    48
	@param	aTransFail If set to ETrue, sends the KErrHTTPOptimiserFailsTrans event to the client. 
williamr@2
    49
	@leave		KErrNoMemory On insuffcient memory conditions.
williamr@2
    50
	*/
williamr@2
    51
	virtual void DecodeL (const TDesC8& aData, HBufC8*& aHttpData, TBool& aTransFail) = 0;
williamr@2
    52
};
williamr@2
    53
williamr@2
    54
williamr@2
    55
#endif //	__MHTTPDATAOPTIMISER_H__