applayerpluginsandutils/httpprotocolplugins/wspinc/MWspCLPushCallback.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 MWspCLPushCallback.h
       
    18  @warning : This file contains Rose Model ID comments - please do not delete
       
    19 */
       
    20 
       
    21 #ifndef __MWSPCLPUSHCALLBACK_H__
       
    22 #define __MWSPCLPUSHCALLBACK_H__
       
    23 
       
    24 // System includes
       
    25 #include <e32base.h>
       
    26 
       
    27 // Forward declarations
       
    28 class MWspCLPushInvoker;
       
    29 
       
    30 
       
    31 class MWspCLPushCallback
       
    32 /**
       
    33 @class MWspCLPushCallback
       
    34 @since			7.0
       
    35 The MWspCLPushInvoker and MWspCLPushCallback form the API that provides the 
       
    36 WSP Connectionless Session Service Push facility, as in the WSP Specification,
       
    37 July 2001. The MWspCLMethodInvoker interface is supplied by the Provider 
       
    38 entity. The MWspCLMethodCallback interface is supplied by the Client entity.
       
    39 The Provider implements the communications necessary to send the primitives 
       
    40 issued by the Client to the Server, and from the Server to the Client.
       
    41 
       
    42 The Client object that encapsulates a push transaction implements the call-back
       
    43 API MWspCLPushCallback. Internally, the Provider should associate each of these
       
    44 objects with a WSP Push Id in order to distinguish between push transactions.
       
    45 @publishedAll
       
    46 @deprecated
       
    47 */
       
    48 	{
       
    49 public:	// Methods
       
    50 
       
    51 /**
       
    52 	@fn				UnitPushInd(const TDesC8& aPushHeader, const TDesC8& aPushBody) =0
       
    53 	Intended Usage	:	This represents the S-Unit-Push.ind primitive. The 
       
    54 						Provider issues this when it receives Push information.
       
    55 						The Client supplies a new listening Push transaction 
       
    56 						object, via the MWspCLPushInvoker API, to maintain the
       
    57 						correct number of these objects in the Provider.
       
    58 	@since			7.0
       
    59 	@param			aPushHeader	A buffer that contains the byte-encoded headers 
       
    60 								for the Push information.
       
    61 	@param			aPushBody	A buffer that contains the body of the Push 
       
    62 								information.
       
    63 	@pre 			There is a listening Push transaction object available in 
       
    64 					the Provider.
       
    65 	@post			The number of available Push transaction objects available
       
    66 					in the Provider is reduced by one.
       
    67  */
       
    68 	virtual void UnitPushInd(
       
    69 							const TDesC8&	aPushHeader,
       
    70 							const TDesC8&	aPushBody
       
    71 							) =0;
       
    72 
       
    73 	};
       
    74 
       
    75 #endif	// __MWSPCLPUSHCALLBACK_H__
       
    76