remotecontrol/remotecontrolfw/client/intermediate/inc/receiver.h
author hgs
Wed, 13 Oct 2010 16:20:29 +0300
changeset 51 20ac952a623c
permissions -rw-r--r--
201040_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
20ac952a623c 201040_02
hgs
parents:
diff changeset
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
20ac952a623c 201040_02
hgs
parents:
diff changeset
     2
// All rights reserved.
20ac952a623c 201040_02
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
20ac952a623c 201040_02
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
20ac952a623c 201040_02
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
20ac952a623c 201040_02
hgs
parents:
diff changeset
     7
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
     8
// Initial Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    10
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    11
// Contributors:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    12
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    13
// Description:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    14
//
20ac952a623c 201040_02
hgs
parents:
diff changeset
    15
20ac952a623c 201040_02
hgs
parents:
diff changeset
    16
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    17
 @file
20ac952a623c 201040_02
hgs
parents:
diff changeset
    18
 @internalComponent
20ac952a623c 201040_02
hgs
parents:
diff changeset
    19
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    20
20ac952a623c 201040_02
hgs
parents:
diff changeset
    21
#ifndef RECEIVER_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    22
#define RECEIVER_H
20ac952a623c 201040_02
hgs
parents:
diff changeset
    23
20ac952a623c 201040_02
hgs
parents:
diff changeset
    24
#include <e32base.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    25
#include <remconinterfaceselector.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    26
#include <remcon/messagetype.h>
20ac952a623c 201040_02
hgs
parents:
diff changeset
    27
#include "remconserver.h"
20ac952a623c 201040_02
hgs
parents:
diff changeset
    28
20ac952a623c 201040_02
hgs
parents:
diff changeset
    29
class RRemCon;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    30
20ac952a623c 201040_02
hgs
parents:
diff changeset
    31
/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    32
Active Object for receiving messages from an RRemConController or 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    33
RRemConTarget.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    34
*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    35
NONSHARABLE_CLASS(CReceiver) : public CActive
20ac952a623c 201040_02
hgs
parents:
diff changeset
    36
	{
20ac952a623c 201040_02
hgs
parents:
diff changeset
    37
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    38
	/**
20ac952a623c 201040_02
hgs
parents:
diff changeset
    39
	Factory method.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    40
	@param aRemCon The session to receive on.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    41
	@param aObserver Our observer.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    42
	@param aMaxDataLength The size of the buffer to read operation-associated 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    43
	data into.	
20ac952a623c 201040_02
hgs
parents:
diff changeset
    44
	@param aType The type of session aRemCon is. We pass this back up with new 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    45
	messages so the Interface Selector knows how to handle them.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    46
	@return Ownership of a new CReceiver.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    47
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    48
	static CReceiver* NewL(RRemCon& aRemCon, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    49
		CRemConInterfaceSelector& aObserver, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    50
		TUint aMaxDataLength,
20ac952a623c 201040_02
hgs
parents:
diff changeset
    51
		TRemConClientType aType);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    52
20ac952a623c 201040_02
hgs
parents:
diff changeset
    53
	/** Destructor. */
20ac952a623c 201040_02
hgs
parents:
diff changeset
    54
	~CReceiver();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    55
20ac952a623c 201040_02
hgs
parents:
diff changeset
    56
public:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    57
	/** Called when the client wants to receive a message. On completion, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    58
	notifies the observer and re-issues itself until the client destroys it. 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    59
	*/
20ac952a623c 201040_02
hgs
parents:
diff changeset
    60
	void Receive();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    61
20ac952a623c 201040_02
hgs
parents:
diff changeset
    62
private: // from CActive
20ac952a623c 201040_02
hgs
parents:
diff changeset
    63
	void RunL();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    64
	void DoCancel();
20ac952a623c 201040_02
hgs
parents:
diff changeset
    65
20ac952a623c 201040_02
hgs
parents:
diff changeset
    66
private:
20ac952a623c 201040_02
hgs
parents:
diff changeset
    67
	/** Constructor. */
20ac952a623c 201040_02
hgs
parents:
diff changeset
    68
	CReceiver(RRemCon& aRemCon, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    69
		CRemConInterfaceSelector& aObserver, 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    70
		TRemConClientType aType);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    71
20ac952a623c 201040_02
hgs
parents:
diff changeset
    72
	void ConstructL(TUint aMaxDataLength);
20ac952a623c 201040_02
hgs
parents:
diff changeset
    73
20ac952a623c 201040_02
hgs
parents:
diff changeset
    74
private: // owned
20ac952a623c 201040_02
hgs
parents:
diff changeset
    75
	// These are the members we pass to the inner client API to get messages 
20ac952a623c 201040_02
hgs
parents:
diff changeset
    76
	// out of RemCon.
20ac952a623c 201040_02
hgs
parents:
diff changeset
    77
	TRemConClientReceivePackage iReceivePackage;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    78
	RBuf8 iData;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    79
20ac952a623c 201040_02
hgs
parents:
diff changeset
    80
	const TRemConClientType iType;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    81
20ac952a623c 201040_02
hgs
parents:
diff changeset
    82
private: // unowned
20ac952a623c 201040_02
hgs
parents:
diff changeset
    83
	RRemCon& iRemCon;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    84
	CRemConInterfaceSelector& iObserver;
20ac952a623c 201040_02
hgs
parents:
diff changeset
    85
	};
20ac952a623c 201040_02
hgs
parents:
diff changeset
    86
20ac952a623c 201040_02
hgs
parents:
diff changeset
    87
#endif // RECEIVER_H