epoc32/include/lbs/lbssuplpushreceiver.h
branchSymbian3
changeset 4 837f303aceeb
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
       
     1 // Copyright (c) 2007-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 // Location Based Services SUPL Push Receiver API
       
    15 // 
       
    16 //
       
    17 
       
    18 /**
       
    19  @file
       
    20  @publishedPartner
       
    21  @deprecated
       
    22 */
       
    23 #ifndef SUPL_PUSH_RECEIVER_H
       
    24 #define SUPL_PUSH_RECEIVER_H
       
    25 
       
    26 
       
    27 //-------------------------------------------------------------------------------
       
    28 #include <e32base.h>
       
    29 #include <lbs/lbssuplpushcommon.h>
       
    30 
       
    31 //-------------------------------------------------------------------------------
       
    32 class CLbsSuplPushRecImpl;
       
    33 
       
    34 //-------------------------------------------------------------------------------
       
    35 /**
       
    36 The MLbsSuplPushRecObserver class provides a call-back type of interface that must be
       
    37 used together with the CLbsSuplPushRec class. It is used by the SUPL Protocol Module.
       
    38 A class using the CLbsSuplPushRec interface must derive from MLbsSuplPushRecObserver
       
    39 and implement appropriate virtual methods in order to receive notifications about
       
    40 incoming SUPL INIT messages.
       
    41 
       
    42 @publishedPartner
       
    43 @deprecated
       
    44 
       
    45 @see CLbsSuplPushRec
       
    46 */
       
    47 class MLbsSuplPushRecObserver
       
    48 	{
       
    49 public:
       
    50 	IMPORT_C virtual TVersion Version() const;
       
    51 
       
    52 	/**
       
    53 	Receive notification about an incoming SUPL INIT message. 
       
    54 	
       
    55 	@param aChannel  [In] The channel the call-back is related to.
       
    56 	@param aReqId    [In] An Id of the request the call-back is related to.
       
    57 	@param aMsg      [In] A buffer containing a SUPL INIT message.
       
    58 	
       
    59 	@see CLbsSuplPushRec::SuplInitComplete
       
    60 	@see CLbsSuplPush::SuplInit
       
    61 	*/
       
    62 	virtual void OnSuplInit(TLbsSuplPushChannel aChannel, TLbsSuplPushRequestId aReqId, TDesC8& aMsg) = 0;
       
    63 
       
    64 protected:			
       
    65 	/**
       
    66 	Should not be used. Provides for future expansion of the observer interface. 
       
    67 	Currently not implemented
       
    68 	*/  
       
    69 	IMPORT_C virtual TAny* ExtendedInterface(TInt aFunctionNumber, TAny* aPtr1, TAny* aPtr2);
       
    70 	};
       
    71 
       
    72 
       
    73 //-------------------------------------------------------------------------------
       
    74 /**
       
    75 The CLbsSuplPushRec class provides an interface to allow SUPL INIT messages to be
       
    76 received from SMS or WAP Push frameworks. It is used by the SUPL Protocol Module.
       
    77 SUPL INIT messages are sent into the LBS subsystem using the CLbsSuplPush class.
       
    78 
       
    79 @publishedPartner
       
    80 @deprecated
       
    81 @see MLbsSuplPushRecObserver
       
    82 @see CLbsSuplPush
       
    83 */
       
    84 NONSHARABLE_CLASS(CLbsSuplPushRec) : public CBase
       
    85 	{
       
    86 public:
       
    87 	IMPORT_C static CLbsSuplPushRec* NewL(MLbsSuplPushRecObserver& aObserver);
       
    88 	virtual ~CLbsSuplPushRec();
       
    89 	
       
    90 public:
       
    91 	IMPORT_C TInt SuplInitComplete(TLbsSuplPushChannel aChannel, 
       
    92 								   TLbsSuplPushRequestId aReqId, 
       
    93 								   TInt aError, 
       
    94 								   TInt aReserved);
       
    95 	
       
    96 private:
       
    97 	CLbsSuplPushRec();
       
    98 	void ConstructL(MLbsSuplPushRecObserver& aObserver);
       
    99 	
       
   100 	//** Prohibit copy constructor */
       
   101 	CLbsSuplPushRec(const CLbsSuplPushRec&);
       
   102 	//** Prohibit assigment operator */
       
   103 	CLbsSuplPushRec& operator= (const CLbsSuplPushRec&);
       
   104 
       
   105 private:
       
   106 	/** CLbsSuplPushRecImpl* Impl is the internal handle to the Implementation */
       
   107 	CLbsSuplPushRecImpl* iImpl;
       
   108 	};
       
   109 
       
   110 #endif //SUPL_PUSH_RECEIVER_H