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 MWspCLMethodInvoker.h

    18  @warning : This file contains Rose Model ID comments - please do not delete

    19 */

    20 

    21 #ifndef __MWSPCLMETHODINVOKER_H__

    22 #define __MWSPCLMETHODINVOKER_H__

    23 

    24 // System includes

    25 #include <e32base.h>

    26 

    27 // Forward declarations

    28 class MWspCLMethodCallback;

    29 

    30 

    31 class MWspCLMethodInvoker

    32 /**

    33 @class MWspCLMethodInvoker

    34 @since			7.0

    35 The MWspCLMethodInvoker and MWspCLMethodCallback form the API that provides

    36 the WSP Connectionless Session Service Method Invocation facility, as 

    37 described in the WSP Specification, July 2001. 

    38 

    39 The MWspCLMethodInvoker interface is supplied by the Provider entity. The 

    40 MWspCLMethodCallback interface is supplied by the Client entity. The 

    41 Provider implements the communications necessary to send the primitives 

    42 issued by the Client to the Server, and from the Server to the Client.

    43 

    44 The Client object that encapsulates a method transaction implements the call-back

    45 API MWspCLMethodCallback. Internally, the Provider should associate each of these

    46 objects with a WSP Transaction Id in order to distinguish between method transactions.

    47 @publishedAll

    48 @deprecated

    49 */

    50 	{

    51 public:	// Method

    52 

    53 /**

    54 	@fn				UnitMethodInvoke(MWspCLMethodCallback& aMethodCallback, RStringF aMethod, const TUriC8& aRequestUri, const TDesC8& aRequestHeaders, const TDesC8& aRequestBody) =0

    55 	Intended Usage	:	This represents the S-Unit-MethodInvoke primitive. The

    56 						Provider initiates a non-confirmed method with the Server.

    57 						The Client expects the S-Unit-MethodResult primitive to 

    58 						be issued from the Provider.

    59 	@since			7.0

    60 	@param			aMethodCallback	A refernce to an instance of the call-back 

    61 									API MWspCLMethodCallback.It uniquely 

    62 									identifies this  method transaction for the

    63 									lifetime of the transaction.

    64 	@param			aMethod			An RStringF object that describes the HTTP 

    65 									method for this transaction.

    66 	@param			aRequestUri		A URI object that specifies the resource

    67 									to which this operation applies.

    68 	@param			aRequestHeaders	A buffer with the encoded request header.

    69 	@param			aRequestBody	A buffer with the data associated with the 

    70 									request. Only used if the method aMethod 

    71 									supports an entity body.

    72 	@pre 			The underlying layers are prepared for communication. 

    73 	@post			The Provider is waiting for a S-Unit-MethodResult primitive

    74 					from the Server.

    75  */

    76 	virtual void UnitMethodInvoke(

    77 								 MWspCLMethodCallback&	aMethodCallback, 

    78 								 RStringF				aMethod, 

    79 								 const TUriC8&			aRequestUri, 

    80 								 const TDesC8&			aRequestHeader, 

    81 								 const TDesC8&			aRequestBody

    82 								 ) =0;

    83 

    84 /**

    85 	@fn				CancelMethodInvoke(MWspCLMethodCallback& aMethodCallback) =0

    86 	Intended Usage	:	The Client wishes to cancel the method. The call-back

    87 						object pointed to by aMethodCallback is no longer valid.

    88 						The Provider ignores any method responses associated with

    89 						aMethodCallback.

    90 	@since			7.0

    91 	@param			aMethodCallback	A refernce to an instance of the call-back 

    92 									API MWspCLMethodCallback.It uniquely 

    93 									identifies this  method transaction for the

    94 									lifetime of the transaction.

    95 	@pre 			There exists a Transaction Id associated with aMethodCallback.

    96 	@post			Any received S-Unit-MethodResult primitive with a Transaction 

    97 					Id associated with aMethodCallback is ignored.

    98  */

    99 	virtual void CancelMethodInvoke(MWspCLMethodCallback& aMethodCallback) =0;

   100 

   101 	};

   102 

   103 #endif	// __MWSPCLMETHODINVOKER_H__