blob: ab084db7dd608ffa24adfc6b61c9128c7d7206df (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
* CContactDbEventQueue Test module
*
*/
#ifndef __CContactDbEventQueue_H__
#define __CContactDbEventQueue_H__
// INCLUDES
#include <cntdef.h>
#include <cntdbobs.h>
#include "cfixedqueue.h"
// CLASS DECLARATION
class CContactChangeNotifier;
class CContactDatabase;
/**
* Contact Engine event queue class.
*/
class CContactDbEventQueue :
public CTimer, public MContactDbObserver
{
public:
/**
* Creates a new event queue.
* @param aDb contact DB to listen for events.
* @param aMaxQueueSize maximum size of event queue.
* @return a new instance of this class.
*/
static CContactDbEventQueue* NewL
(CContactDatabase* aDb=NULL, TInt aMaxQueueSize=128);
~CContactDbEventQueue();
/**
* Waits for an event from the database.
* @param aTimeOut max time to wait for an event.
* @param aEvent the received event, undefined if this function returns false.
* @return true if an event was received, false if timeout expired first.
*/
TBool ListenForEvent
(TTimeIntervalSeconds aTimeOut,
TContactDbObserverEvent& aEvent);
/**
* Pops Events from the event queue. Required to avoid filling the queue.
*/
void PopEvent();
/**
* Pops All Events from the event queue. Required to avoid queue overflow.
*/
void Clear();
/**
* Removes all previously arrived events from the queue.
*/
inline void Flush()
{
iQueue.Reset();
}
protected: // From MContactDbObserver.
void HandleDatabaseEventL(TContactDbObserverEvent aEvent);
private:
void RunL(); // from CTimer
CContactDbEventQueue();
void ConstructL(CContactDatabase* aDb, TInt aMaxQueueSize);
private:
/// Own: the notifier for attaching to CContactDatabase
CContactChangeNotifier* iNotifier;
/// Own: event queue array
CFixedQueue<TContactDbObserverEvent> iQueue;
};
#endif // __CContactDbEventQueue_H__
|
