epoc32/include/lbs/lbssuplpushreceiver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// Location Based Services SUPL Push Receiver API
williamr@4
    15
// 
williamr@4
    16
//
williamr@4
    17
williamr@4
    18
/**
williamr@4
    19
 @file
williamr@4
    20
 @publishedPartner
williamr@4
    21
 @deprecated
williamr@4
    22
*/
williamr@4
    23
#ifndef SUPL_PUSH_RECEIVER_H
williamr@4
    24
#define SUPL_PUSH_RECEIVER_H
williamr@4
    25
williamr@4
    26
williamr@4
    27
//-------------------------------------------------------------------------------
williamr@4
    28
#include <e32base.h>
williamr@4
    29
#include <lbs/lbssuplpushcommon.h>
williamr@4
    30
williamr@4
    31
//-------------------------------------------------------------------------------
williamr@4
    32
class CLbsSuplPushRecImpl;
williamr@4
    33
williamr@4
    34
//-------------------------------------------------------------------------------
williamr@4
    35
/**
williamr@4
    36
The MLbsSuplPushRecObserver class provides a call-back type of interface that must be
williamr@4
    37
used together with the CLbsSuplPushRec class. It is used by the SUPL Protocol Module.
williamr@4
    38
A class using the CLbsSuplPushRec interface must derive from MLbsSuplPushRecObserver
williamr@4
    39
and implement appropriate virtual methods in order to receive notifications about
williamr@4
    40
incoming SUPL INIT messages.
williamr@4
    41
williamr@4
    42
@publishedPartner
williamr@4
    43
@deprecated
williamr@4
    44
williamr@4
    45
@see CLbsSuplPushRec
williamr@4
    46
*/
williamr@4
    47
class MLbsSuplPushRecObserver
williamr@4
    48
	{
williamr@4
    49
public:
williamr@4
    50
	IMPORT_C virtual TVersion Version() const;
williamr@4
    51
williamr@4
    52
	/**
williamr@4
    53
	Receive notification about an incoming SUPL INIT message. 
williamr@4
    54
	
williamr@4
    55
	@param aChannel  [In] The channel the call-back is related to.
williamr@4
    56
	@param aReqId    [In] An Id of the request the call-back is related to.
williamr@4
    57
	@param aMsg      [In] A buffer containing a SUPL INIT message.
williamr@4
    58
	
williamr@4
    59
	@see CLbsSuplPushRec::SuplInitComplete
williamr@4
    60
	@see CLbsSuplPush::SuplInit
williamr@4
    61
	*/
williamr@4
    62
	virtual void OnSuplInit(TLbsSuplPushChannel aChannel, TLbsSuplPushRequestId aReqId, TDesC8& aMsg) = 0;
williamr@4
    63
williamr@4
    64
protected:			
williamr@4
    65
	/**
williamr@4
    66
	Should not be used. Provides for future expansion of the observer interface. 
williamr@4
    67
	Currently not implemented
williamr@4
    68
	*/  
williamr@4
    69
	IMPORT_C virtual TAny* ExtendedInterface(TInt aFunctionNumber, TAny* aPtr1, TAny* aPtr2);
williamr@4
    70
	};
williamr@4
    71
williamr@4
    72
williamr@4
    73
//-------------------------------------------------------------------------------
williamr@4
    74
/**
williamr@4
    75
The CLbsSuplPushRec class provides an interface to allow SUPL INIT messages to be
williamr@4
    76
received from SMS or WAP Push frameworks. It is used by the SUPL Protocol Module.
williamr@4
    77
SUPL INIT messages are sent into the LBS subsystem using the CLbsSuplPush class.
williamr@4
    78
williamr@4
    79
@publishedPartner
williamr@4
    80
@deprecated
williamr@4
    81
@see MLbsSuplPushRecObserver
williamr@4
    82
@see CLbsSuplPush
williamr@4
    83
*/
williamr@4
    84
NONSHARABLE_CLASS(CLbsSuplPushRec) : public CBase
williamr@4
    85
	{
williamr@4
    86
public:
williamr@4
    87
	IMPORT_C static CLbsSuplPushRec* NewL(MLbsSuplPushRecObserver& aObserver);
williamr@4
    88
	virtual ~CLbsSuplPushRec();
williamr@4
    89
	
williamr@4
    90
public:
williamr@4
    91
	IMPORT_C TInt SuplInitComplete(TLbsSuplPushChannel aChannel, 
williamr@4
    92
								   TLbsSuplPushRequestId aReqId, 
williamr@4
    93
								   TInt aError, 
williamr@4
    94
								   TInt aReserved);
williamr@4
    95
	
williamr@4
    96
private:
williamr@4
    97
	CLbsSuplPushRec();
williamr@4
    98
	void ConstructL(MLbsSuplPushRecObserver& aObserver);
williamr@4
    99
	
williamr@4
   100
	//** Prohibit copy constructor */
williamr@4
   101
	CLbsSuplPushRec(const CLbsSuplPushRec&);
williamr@4
   102
	//** Prohibit assigment operator */
williamr@4
   103
	CLbsSuplPushRec& operator= (const CLbsSuplPushRec&);
williamr@4
   104
williamr@4
   105
private:
williamr@4
   106
	/** CLbsSuplPushRecImpl* Impl is the internal handle to the Implementation */
williamr@4
   107
	CLbsSuplPushRecImpl* iImpl;
williamr@4
   108
	};
williamr@4
   109
williamr@4
   110
#endif //SUPL_PUSH_RECEIVER_H