epoc32/include/mw/http/rhttpsession.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    12 //
    12 //
    13 // Description:
    13 // Description:
    14 //
    14 //
    15 
    15 
    16 
       
    17 
       
    18 /**
    16 /**
    19  @file RHTTPSession.h
    17  @file
    20  @warning : This file contains Rose Model ID comments - please do not delete
    18  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    19 */
    22 
    20 
    23 #ifndef __RHTTPSESSION_H__
    21 #ifndef __RHTTPSESSION_H__
    24 #define __RHTTPSESSION_H__ 
    22 #define __RHTTPSESSION_H__ 
   214 					TCertInfo has been deprecated since v9.2. CCertificate may be used as an alternative.
   212 					TCertInfo has been deprecated since v9.2. CCertificate may be used as an alternative.
   215 	*/
   213 	*/
   216 	//##ModelId=3C4C187B02AA
   214 	//##ModelId=3C4C187B02AA
   217 	IMPORT_C TInt ServerCert(TCertInfo& aServerCert);
   215 	IMPORT_C TInt ServerCert(TCertInfo& aServerCert);
   218 
   216 
   219 
   217 	#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
       
   218 	/** Obtain the server certificate information for this session.  This function
       
   219 		should only be used for WSP. HTTP should use RHttpTransaction::ServerCert.
       
   220 		@see RHttpSession::ServerCert
       
   221 		@prototype
       
   222 		@return	a CCertificate pointer to an CWTLSCertificate object.
       
   223 		Calling code can safely cast to CWTLSCertificate if using  "WSP/WSP".
       
   224 		NULL returned if certificate information not found.
       
   225 	*/
       
   226 	#else
   220 	/** Obtain the server certificate information for this session.  This function
   227 	/** Obtain the server certificate information for this session.  This function
   221 		should only be used for WSP. HTTP should use RHttpTransaction::ServerCert.
   228 		should only be used for WSP. HTTP should use RHttpTransaction::ServerCert.
   222 		@see RHttpSession::ServerCert
   229 		@see RHttpSession::ServerCert
   223 		@internalAll
   230 		@internalAll
   224 		@prototype
   231 		@prototype
   225 		@return	a CCertificate pointer to an CWTLSCertificate object.
   232 		@return	a CCertificate pointer to an CWTLSCertificate object.
   226 		Calling code can safely cast to CWTLSCertificate if using  "WSP/WSP".
   233 		Calling code can safely cast to CWTLSCertificate if using  "WSP/WSP".
   227 		NULL returned if certificate information not found.
   234 		NULL returned if certificate information not found.
   228 	*/
   235 	*/
   229 	IMPORT_C const CCertificate* RHTTPSession::ServerCert();
   236 	#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
       
   237 	IMPORT_C const CCertificate* ServerCert();
   230 
   238 
   231 	/** Connect this WSP session. This function does nothing when called for text-mode.
   239 	/** Connect this WSP session. This function does nothing when called for text-mode.
   232 	*/
   240 	*/
   233 	//##ModelId=3C4C187B02A9
   241 	//##ModelId=3C4C187B02A9
   234 	IMPORT_C void ConnectL();
   242 	IMPORT_C void ConnectL();
   235 
   243 
   236 	/** Disconnect this WSP session. This function does nothing when called for text-mode.
   244 	/** Disconnect this WSP session. This function does nothing when called for text-mode.
   237 	*/
   245 	*/
   238 	//##ModelId=3C4C187B02A8
   246 	//##ModelId=3C4C187B02A8
   239 	IMPORT_C void DisconnectL();
   247 	IMPORT_C void DisconnectL();
   240 	
   248 
       
   249 	#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
   241 	/**Set the default Proxy for Http Session. This function reads default proxy information,if available, from CommsDat
   250 	/**Set the default Proxy for Http Session. This function reads default proxy information,if available, from CommsDat
   242 	and uses it for the current Session.
   251 	and uses it for the current Session.
   243 	@internalAll
   252 	@internalAll
   244 	*/
   253 	*/
   245 	IMPORT_C void SetupDefaultProxyFromCommsDatL();
   254 	IMPORT_C void SetupDefaultProxyFromCommsDatL();
   246 
   255 
       
   256 	#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
       
   257 
       
   258 	#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS	
       
   259 	/**Sets the HTTP data optimiser for the session.
       
   260 	@param aHttpOptimiser An object of the implementation of interface, MHttpDataOptimiser, supplied by the client.
       
   261 	*/
       
   262 	#else
   247 	/**Sets the HTTP data optimiser for the session.
   263 	/**Sets the HTTP data optimiser for the session.
   248 	@param aHttpOptimiser An object of the implementation of interface, MHttpDataOptimiser, supplied by the client.
   264 	@param aHttpOptimiser An object of the implementation of interface, MHttpDataOptimiser, supplied by the client.
   249 	@publishedPartner
   265 	@publishedPartner
   250 	*/
   266 	@released
       
   267 	*/
       
   268 	#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
   251 	IMPORT_C void SetupHttpDataOptimiser (MHttpDataOptimiser& aHttpOptimiser);
   269 	IMPORT_C void SetupHttpDataOptimiser (MHttpDataOptimiser& aHttpOptimiser);
   252  
   270  	
       
   271 	#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS	
       
   272  	/**Returns the object of the MHttpDataOptimiser implementation class.
       
   273 	*/
       
   274 	#else
   253  	/**Returns the object of the MHttpDataOptimiser implementation class.
   275  	/**Returns the object of the MHttpDataOptimiser implementation class.
   254 	@internalTechnology
   276 	@internalTechnology
   255 	*/
   277 	*/
       
   278 	#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
   256  	IMPORT_C MHttpDataOptimiser* HttpDataOptimiser ();
   279  	IMPORT_C MHttpDataOptimiser* HttpDataOptimiser ();
   257 
   280 
   258 private:
   281 private:
   259 	friend class RHTTPFilterCollection;
   282 	friend class RHTTPFilterCollection;
   260 	friend class CHTTPSession;
   283 	friend class CHTTPSession;