epoc32/include/uikon/eikalsrv.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
 @internalComponent
williamr@2
    21
*/
williamr@2
    22
williamr@2
    23
#ifndef __EIKALSRV_H__
williamr@2
    24
#define __EIKALSRV_H__
williamr@2
    25
williamr@2
    26
#include <e32base.h>
williamr@2
    27
#include <asaltdefs.h>
williamr@2
    28
#include <asshddefs.h>
williamr@2
    29
williamr@2
    30
class MEikServAlarmFactory;
williamr@2
    31
class MEikServAlarm;
williamr@2
    32
class CEikServAlarmAlertSession;
williamr@2
    33
williamr@2
    34
/** 
williamr@2
    35
@internalComponent
williamr@2
    36
*/
williamr@2
    37
NONSHARABLE_CLASS(CEikServAlarmAlertServer) : public CPolicyServer
williamr@2
    38
	{
williamr@2
    39
public:
williamr@2
    40
	IMPORT_C static CEikServAlarmAlertServer* NewL(MEikServAlarmFactory* aAlarmControlFactory);
williamr@2
    41
	IMPORT_C static CEikServAlarmAlertServer* NewL(MEikServAlarmFactory* aAlarmControlFactory, TInt aMaxAlarms);
williamr@2
    42
	~CEikServAlarmAlertServer();
williamr@2
    43
	IMPORT_C void HandleSwitchOnEvent();
williamr@2
    44
	IMPORT_C void TaskKeyPressedL();
williamr@2
    45
	inline TBool AlarmAlertIsVisible() const;
williamr@2
    46
	inline void SessionDied();
williamr@2
    47
	IMPORT_C void SetQuietPeriodL(TTime aQuietPeriodEndTime);
williamr@2
    48
	IMPORT_C void ClearAllAlarmsL();	
williamr@2
    49
public: // from CPolicyServer
williamr@2
    50
	CSession2* NewSessionL(const TVersion& aVersion, const RMessage2& aMessage) const;
williamr@2
    51
private:
williamr@2
    52
	CEikServAlarmAlertServer(TInt aPriority, MEikServAlarmFactory& aAlarmControlFactory,  TInt aMaxAlarms);
williamr@2
    53
private:
williamr@2
    54
	CEikServAlarmAlertSession* iSession; // iSession does not *own* what it points to
williamr@2
    55
	MEikServAlarmFactory& iAlarmControlFactory;
williamr@2
    56
	TInt iMaxAlarms;
williamr@2
    57
	};
williamr@2
    58
williamr@2
    59
williamr@2
    60
class CEikAlmControlSupervisor;
williamr@2
    61
williamr@2
    62
/** 
williamr@2
    63
Helper class for CEikServAlarmAlertSession. Holds response data for queuing
williamr@2
    64
@internalComponent
williamr@2
    65
*/
williamr@2
    66
NONSHARABLE_CLASS(TAlarmResponse)
williamr@2
    67
	{
williamr@2
    68
public:	
williamr@2
    69
	TAlarmResponse (TASAltAlertServerResponse  aCode,  TAlarmId aId, TTime aTime);
williamr@2
    70
	TASAltAlertServerResponse ResponseCode () const;
williamr@2
    71
	TAlarmId AlarmId () const;
williamr@2
    72
	TTime TimeToSnooze() const;
williamr@2
    73
private:
williamr@2
    74
	TASAltAlertServerResponse  iCode;
williamr@2
    75
	TAlarmId iId;
williamr@2
    76
	TTime iTime;
williamr@2
    77
	};
williamr@2
    78
	
williamr@2
    79
// supposed to be maximum one response in a queue, because client should resubmit request 
williamr@2
    80
// for response as soon	as it receive previous 
williamr@2
    81
const TInt KAlertResponseQueueSize = 20;	
williamr@2
    82
williamr@2
    83
/**
williamr@2
    84
Represents a session for a client thread on the server-side.
williamr@2
    85
@internalComponent 
williamr@2
    86
*/
williamr@2
    87
NONSHARABLE_CLASS(CEikServAlarmAlertSession) : public CSession2
williamr@2
    88
	{
williamr@2
    89
public:
williamr@2
    90
	static CEikServAlarmAlertSession* NewL(MEikServAlarmFactory& aAlarmControlFactory, TInt aMaxAlarms);
williamr@2
    91
	~CEikServAlarmAlertSession();
williamr@2
    92
	void TaskKeyPressedL();
williamr@2
    93
	void HandleSwitchOnEvent();
williamr@2
    94
	inline TBool AlarmAlertIsVisible() const;
williamr@2
    95
williamr@2
    96
	void SetQuietPeriodL(TTime aQuietPeriodEndTime);
williamr@2
    97
	inline TTime QuietPeriodEndTime() const; 
williamr@2
    98
	void RespondEventL(TASAltAlertServerResponse aCode);
williamr@2
    99
	void RespondEventL(TASAltAlertServerResponse aCode, TAlarmId aId, TTime aTimeToSnooze = 0);
williamr@2
   100
	void ClearAllAlarmsL();
williamr@2
   101
private:
williamr@2
   102
	CEikServAlarmAlertServer* AlarmAlertServer() const;
williamr@2
   103
	void ConstructL();
williamr@2
   104
	virtual void ServiceL(const RMessage2 &aMessage);
williamr@2
   105
williamr@2
   106
	CEikServAlarmAlertSession(MEikServAlarmFactory& aAlarmControl, TInt aMaxAlarms);
williamr@2
   107
	void QueueEventL (TASAltAlertServerResponse&  aCode,TAlarmId& aId, TTime& aTimeToSnooze);
williamr@2
   108
	TInt FindAlarm(TAlarmId aAlarmId) const;
williamr@2
   109
	void DeleteAlarmL(const RMessage2& aMessage);
williamr@2
   110
	void UpdateVisibility();
williamr@2
   111
private:
williamr@2
   112
	TBool iVisible;
williamr@2
   113
	MEikServAlarmFactory& iAlarmControlFactory;
williamr@2
   114
	TTime iQuietPeriodEndTime;
williamr@2
   115
	TInt iMaxAlarms;
williamr@2
   116
	RPointerArray<CEikAlmControlSupervisor> iAlarmSupervisors;
williamr@2
   117
	RArray <TAlarmResponse> iResponseQueue;
williamr@2
   118
	RMessage2 iMessage;
williamr@2
   119
	};
williamr@2
   120
williamr@2
   121
inline TBool CEikServAlarmAlertServer::AlarmAlertIsVisible() const 
williamr@2
   122
	{ return iSession->AlarmAlertIsVisible(); }
williamr@2
   123
williamr@2
   124
inline TBool CEikServAlarmAlertSession::AlarmAlertIsVisible() const 
williamr@2
   125
	{ return iVisible; }
williamr@2
   126
williamr@2
   127
inline void CEikServAlarmAlertServer::SessionDied() 
williamr@2
   128
	{ iSession = NULL; }
williamr@2
   129
williamr@2
   130
inline TTime CEikServAlarmAlertSession::QuietPeriodEndTime() const 
williamr@2
   131
	{ return iQuietPeriodEndTime; }
williamr@2
   132
williamr@2
   133
#endif //__EIKALSRV_H__