applayerpluginsandutils/httpprotocolplugins/wspinc/MWspProxyInfoProvider.h
changeset 0 b16258d2340f
equal deleted inserted replaced
-1:000000000000 0:b16258d2340f
       
     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 MWspProxyInfoProvider.h
       
    18  @warning : This file contains Rose Model ID comments - please do not delete
       
    19 */
       
    20 
       
    21 #ifndef __MWSPPROXYINFOPROVIDER_H__
       
    22 #define __MWSPPROXYINFOPROVIDER_H__
       
    23 
       
    24 // System includes
       
    25 #include <e32base.h>
       
    26 #include <wsp/wsptypes.h>
       
    27 
       
    28 // Types used for arguments in this file (e.g. TWspBearer) are from the Wap namespace
       
    29 using namespace Wap;
       
    30 
       
    31 
       
    32 class MWspProxyInfoProvider
       
    33 /**
       
    34 @class MWspProxyInfoProvider
       
    35 @since			7.0
       
    36 The MWspProxyInfoProvider API provides an interface to the bearer connection
       
    37 information that has been specified by the Client. 
       
    38 @publishedAll
       
    39 @deprecated
       
    40 */
       
    41 	{
       
    42 public:	// Methods
       
    43 
       
    44 /** @fn				ProxyAddress() const =0
       
    45 	Intended Usage	:	Identifies the peer with which the WSP session is to be
       
    46 						established. The format of the this data is dependent on
       
    47 						the type of bearer to be used in the connection. In the
       
    48 						case of an SMS bearer, the Proxy peer is identified by a
       
    49 						telephone number.
       
    50 	@since			7.0
       
    51 	@return			A const reference to a buffer containing the proxy address. 
       
    52 */	  
       
    53 	virtual const TDesC8& ProxyAddress() const =0;
       
    54 
       
    55 /** @fn				RemotePort() const =0
       
    56 	Intended Usage	:	Identifies the port on the remote peer with which the 
       
    57 						connection for the WSP session should be made. This is
       
    58 						only relevant for certain bearers, e.g. IP bearer. A
       
    59 						value of zero is invalid and is used to indicate that
       
    60 						either a port has not been specified or it is not
       
    61 						relevant to the chosen bearer
       
    62 	@since			7.0
       
    63 	@return			A word specifying the remote port number.
       
    64 */	  
       
    65 	virtual TUint16 RemotePort() const =0;
       
    66 
       
    67 /** @fn				LocalPort() const =0
       
    68 	Intended Usage	:	Identifies the port on the local peer. A value of
       
    69 						zero is invalid and is used to indicate that either
       
    70 						a port has not been specified or it is not relevant
       
    71 						to the chosen bearer
       
    72 	@since			7.0
       
    73 	@return			A word specifying the local port number
       
    74 */	  
       
    75 	virtual TUint16 LocalPort() const =0;
       
    76 
       
    77 /** @fn				Bearer() const =0
       
    78 	Intended Usage	:	Identifies the type of bearer network which the Server
       
    79 						address should be used with.
       
    80 	@since			7.0
       
    81 	@return			An enum specifying the type of bearer network.
       
    82 */	  
       
    83 	virtual TWspBearer Bearer() const =0;
       
    84 
       
    85 /**	@fn				ServiceCentreNumber() const =0
       
    86 	Intended Usage	:	The telephone number for the SMS service centre. This is
       
    87 						only relavent for an SMS bearer.
       
    88 	@since			7.0
       
    89 	@return			A reference to a buffer containing the telephone number of
       
    90 					the service centre.
       
    91 */
       
    92 	virtual const TDesC8& ServiceCentreNumber() const =0;
       
    93 
       
    94 /**	@fn				WspSessionService() const =0
       
    95 	Intended Usage	:	The type WSP Session Service set in the proxy info. This
       
    96 						can be either ConnectionOriented or Connectionless.
       
    97 	@since			7.0
       
    98 	@return			An enum specifying the Wsp Session Service type
       
    99 */
       
   100 	virtual TWspSession WspSessionService() const =0;
       
   101 
       
   102 /** @fn				SecureConnection() const =0
       
   103 	Intended Usage	:	Identifies the security to be used in the WSP session.
       
   104 	@since			7.0
       
   105 	@return			A flag that indicates whether the WSP session is to be secured
       
   106 					with WTLS or not.
       
   107 */	  
       
   108 	virtual TBool SecureConnection() const =0;
       
   109 	};
       
   110 
       
   111 #endif //	__MWSPPROXYINFOPROVIDER_H__