Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_alarm_server_example_8cpp_source.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/AppServices/AlarmServer/AlarmServerExample.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/AppServices/AlarmServer/AlarmServerExample.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="comment">// System includes</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <e32base.h></span>
<a name="l00018"></a>00018 <span class="preprocessor">#include <e32cons.h></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <asshdalarm.h></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <asclisession.h></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// Local includes</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "AlarmServerExample.h"</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// Global definition</span>
<a name="l00026"></a>00026 <span class="keyword">static</span> CConsoleBase* gConsole;
<a name="l00027"></a>00027 <span class="comment">// Strings for display</span>
<a name="l00028"></a>00028 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleStars,<span class="stringliteral">"\n*************************"</span>);
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <a class="code" href="class_c_example_alarm_server.html">CExampleAlarmServer</a>* CExampleAlarmServer::NewL()
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <a class="code" href="class_c_example_alarm_server.html">CExampleAlarmServer</a>* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_example_alarm_server.html">CExampleAlarmServer</a>();
<a name="l00033"></a>00033 CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00034"></a>00034 <span class="keyword">self</span>->ConstructL();
<a name="l00035"></a>00035 CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00036"></a>00036 <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00037"></a>00037 }
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keywordtype">void</span> CExampleAlarmServer::ConstructL()
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="comment">// connect to the alarm server</span>
<a name="l00042"></a>00042 User::LeaveIfError(iAlarmServerSession.Connect());
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044
<a name="l00045"></a>00045 CExampleAlarmServer::~CExampleAlarmServer()
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 iAlarmServerSession.Close();
<a name="l00048"></a>00048 }
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">// Called each time the alarm server generates an event. Displays a description of the event.</span>
<a name="l00051"></a>00051 <span class="keywordtype">void</span> CExampleAlarmServer::DisplayNotificationType(TAlarmChangeEvent aAlarmChangeEvent, TAlarmId <span class="comment">/*aAlarmId*/</span>)
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keywordflow">switch</span> (aAlarmChangeEvent)
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 <span class="keywordflow">case</span> EAlarmChangeEventUndefined:
<a name="l00056"></a>00056 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg, <span class="stringliteral">"\nAn undefined alarm event has occurred."</span>);
<a name="l00057"></a>00057 gConsole->Printf(KConsoleMsg);
<a name="l00058"></a>00058 <span class="keywordflow">break</span>;
<a name="l00059"></a>00059 <span class="keywordflow">case</span> EAlarmChangeEventState:
<a name="l00060"></a>00060 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg1, <span class="stringliteral">"\nAn alarm has changed state."</span>);
<a name="l00061"></a>00061 gConsole->Printf(KConsoleMsg1);
<a name="l00062"></a>00062 <span class="keywordflow">break</span>;
<a name="l00063"></a>00063 <span class="keywordflow">case</span> EAlarmChangeEventStatus:
<a name="l00064"></a>00064 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg2, <span class="stringliteral">"\nAn alarm has changed status."</span>);
<a name="l00065"></a>00065 gConsole->Printf(KConsoleMsg2);
<a name="l00066"></a>00066 <span class="keywordflow">break</span>;
<a name="l00067"></a>00067 <span class="keywordflow">case</span> EAlarmChangeEventCharacteristics:
<a name="l00068"></a>00068 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg3, <span class="stringliteral">"\nAn alarm has changed characteristics.."</span>);
<a name="l00069"></a>00069 gConsole->Printf(KConsoleMsg3);
<a name="l00070"></a>00070 <span class="keywordflow">break</span>;
<a name="l00071"></a>00071 <span class="keywordflow">case</span> EAlarmChangeEventAlarmDeletion:
<a name="l00072"></a>00072 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg4, <span class="stringliteral">"\nAn alarm has been deleted from the queue."</span>);
<a name="l00073"></a>00073 gConsole->Printf(KConsoleMsg4);
<a name="l00074"></a>00074 <span class="keywordflow">break</span>;
<a name="l00075"></a>00075 <span class="keywordflow">case</span> EAlarmChangeEventAlarmAddition:
<a name="l00076"></a>00076 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg5, <span class="stringliteral">"\nAn alarm has been added to the queue."</span>);
<a name="l00077"></a>00077 gConsole->Printf(KConsoleMsg5);
<a name="l00078"></a>00078 <span class="keywordflow">break</span>;
<a name="l00079"></a>00079 <span class="keywordflow">case</span> EAlarmChangeEventTimerExpired:
<a name="l00080"></a>00080 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg6, <span class="stringliteral">"\nAn alarm has expired."</span>);
<a name="l00081"></a>00081 gConsole->Printf(KConsoleMsg6);
<a name="l00082"></a>00082 <span class="keywordflow">break</span>;
<a name="l00083"></a>00083 <span class="keywordflow">case</span> EAlarmChangeEventSoundPlaying:
<a name="l00084"></a>00084 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg7, <span class="stringliteral">"\nThe sound for an alarm has just started playing."</span>);
<a name="l00085"></a>00085 gConsole->Printf(KConsoleMsg7);
<a name="l00086"></a>00086 <span class="keywordflow">break</span>;
<a name="l00087"></a>00087 <span class="keywordflow">case</span> EAlarmChangeEventSoundStopped:
<a name="l00088"></a>00088 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg8, <span class="stringliteral">"\nThe sound for an alarm has just stopped playing."</span>);
<a name="l00089"></a>00089 gConsole->Printf(KConsoleMsg8);
<a name="l00090"></a>00090 <span class="keywordflow">break</span>;
<a name="l00091"></a>00091 <span class="keywordflow">case</span> EAlarmChangeEventPlayIntervalsChanged:
<a name="l00092"></a>00092 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg9, <span class="stringliteral">"\nThe sound intervals associated with sound timing have changed."</span>);
<a name="l00093"></a>00093 gConsole->Printf(KConsoleMsg9);
<a name="l00094"></a>00094 <span class="keywordflow">break</span>;
<a name="l00095"></a>00095 <span class="keywordflow">case</span> EAlarmChangeEventGlobalSoundStateChanged:
<a name="l00096"></a>00096 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg10, <span class="stringliteral">"\nThe global sound state (on/off) has changed."</span>);
<a name="l00097"></a>00097 gConsole->Printf(KConsoleMsg10);
<a name="l00098"></a>00098 <span class="keywordflow">break</span>;
<a name="l00099"></a>00099 <span class="keywordflow">case</span> EAlarmChangeEventHeadQueueItemChanged:
<a name="l00100"></a>00100 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg11, <span class="stringliteral">"\nThe next alarm at the head of the alarm queue has changed."</span>);
<a name="l00101"></a>00101 gConsole->Printf(KConsoleMsg11);
<a name="l00102"></a>00102 <span class="keywordflow">break</span>;
<a name="l00103"></a>00103 <span class="keywordflow">case</span> EAlarmChangeEventSystemDateTimeChanged:
<a name="l00104"></a>00104 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg12, <span class="stringliteral">"\nThe system date or time has changed, or the days defined as workdays have changed."</span>);
<a name="l00105"></a>00105 gConsole->Printf(KConsoleMsg12);
<a name="l00106"></a>00106 <span class="keywordflow">break</span>;
<a name="l00107"></a>00107 <span class="keywordflow">case</span> EAlarmChangeEventAlarmUIVisible:
<a name="l00108"></a>00108 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg13, <span class="stringliteral">"\nThe alarm alert server has been instructed to show the 'alarm expired' display."</span>);
<a name="l00109"></a>00109 gConsole->Printf(KConsoleMsg13);
<a name="l00110"></a>00110 <span class="keywordflow">break</span>;
<a name="l00111"></a>00111 <span class="keywordflow">case</span> EAlarmChangeEventAlarmUIInvisible:
<a name="l00112"></a>00112 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg14, <span class="stringliteral">"\nThe alarm alert server has been instructed to hide the 'alarm expired' display."</span>);
<a name="l00113"></a>00113 gConsole->Printf(KConsoleMsg14);
<a name="l00114"></a>00114 <span class="keywordflow">break</span>;
<a name="l00115"></a>00115 <span class="keywordflow">case</span> EAlarmChangeEventSoundSilence:
<a name="l00116"></a>00116 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg15, <span class="stringliteral">"\nAlarm sounds have been temporarily silenced, the current alarm has been paused or re-enabled."</span>);
<a name="l00117"></a>00117 gConsole->Printf(KConsoleMsg15);
<a name="l00118"></a>00118 <span class="keywordflow">break</span>;
<a name="l00119"></a>00119 <span class="keywordflow">case</span> EAlarmChangeEventAlarmData:
<a name="l00120"></a>00120 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg16, <span class="stringliteral">"\nThe data associated with an alarm has changed."</span>);
<a name="l00121"></a>00121 gConsole->Printf(KConsoleMsg16);
<a name="l00122"></a>00122 <span class="keywordflow">break</span>;
<a name="l00123"></a>00123 <span class="keywordflow">case</span> EAlarmChangeEventRestoreStarted:
<a name="l00124"></a>00124 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg17, <span class="stringliteral">"\nA restore from backup of the alarm server has started. Alarms cannot be added/deleted until this has finished."</span>);
<a name="l00125"></a>00125 gConsole->Printf(KConsoleMsg17);
<a name="l00126"></a>00126 <span class="keywordflow">break</span>;
<a name="l00127"></a>00127 <span class="keywordflow">case</span> EAlarmChangeEventRestoreFailed:
<a name="l00128"></a>00128 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg18, <span class="stringliteral">"\nA restore from backup of the alarm server has failed. Alarms can be added/deleted again."</span>);
<a name="l00129"></a>00129 gConsole->Printf(KConsoleMsg18);
<a name="l00130"></a>00130 <span class="keywordflow">break</span>;
<a name="l00131"></a>00131 <span class="keywordflow">case</span> EAlarmChangeEventRestoreCompleted:
<a name="l00132"></a>00132 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg19, <span class="stringliteral">"\nA restore from backup of the alarm server has completed. The alarm queue has changed."</span>);
<a name="l00133"></a>00133 gConsole->Printf(KConsoleMsg19);
<a name="l00134"></a>00134 <span class="keywordflow">break</span>;
<a name="l00135"></a>00135 <span class="keywordflow">case</span> EAlarmChangeEventLast:
<a name="l00136"></a>00136 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg20, <span class="stringliteral">"\nLast change event (anchor). This is always at the end of the list."</span>);
<a name="l00137"></a>00137 gConsole->Printf(KConsoleMsg20);
<a name="l00138"></a>00138 <span class="keywordflow">break</span>;
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140 }
<a name="l00141"></a>00141
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">// Waits for the alarm to be cleared by the user.</span>
<a name="l00144"></a>00144 <span class="comment">// In the meantime, prints out descriptions of all change events generated by server.</span>
<a name="l00145"></a>00145 <span class="keywordtype">void</span> CExampleAlarmServer::WaitForAlarmToBeCleared()
<a name="l00146"></a>00146 {
<a name="l00147"></a>00147 TAlarmChangeEvent alarmChangeEvent;
<a name="l00148"></a>00148 <span class="keywordflow">do</span>
<a name="l00149"></a>00149 {
<a name="l00150"></a>00150 TRequestStatus status;
<a name="l00151"></a>00151 TAlarmId alarmId;
<a name="l00152"></a>00152 iAlarmServerSession.NotifyChange(status, alarmId);
<a name="l00153"></a>00153 User::WaitForRequest(status);
<a name="l00154"></a>00154 alarmChangeEvent = <span class="keyword">static_cast<</span>TAlarmChangeEvent<span class="keyword">></span>(status.Int());
<a name="l00155"></a>00155 DisplayNotificationType(alarmChangeEvent,alarmId);
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157 <span class="comment">// EAlarmChangeEventAlarmUIInvisible is generated when the alarm is cleared</span>
<a name="l00158"></a>00158 <span class="keywordflow">while</span> (alarmChangeEvent != EAlarmChangeEventAlarmUIInvisible);
<a name="l00159"></a>00159 }
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="comment">// Sets a floating alarm and adds it to the alarmserver queue.</span>
<a name="l00162"></a>00162 <span class="comment">// This is an alarm that is set using local time, for example a morning wake up call.</span>
<a name="l00163"></a>00163 <span class="keywordtype">void</span> CExampleAlarmServer::SetFloatingAlarmL()
<a name="l00164"></a>00164 {
<a name="l00165"></a>00165 <span class="comment">/*</span>
<a name="l00166"></a>00166 <span class="comment"> There are two types of alarms - floating and fixed.</span>
<a name="l00167"></a>00167 <span class="comment"> For a floating alarm, time is set in local time by using TASShdAlarm::NextDueTime().</span>
<a name="l00168"></a>00168 <span class="comment"> A floating alarm will be rescheduled when the UTC offset is changed.</span>
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment"> In case of fixed alarms, time is set in UTC by using TASShdAlarm::SetUtcNextDueTime().</span>
<a name="l00171"></a>00171 <span class="comment"> A fixed alarm will not be rescheduled when the UTC offset is changed.</span>
<a name="l00172"></a>00172 <span class="comment"> */</span>
<a name="l00173"></a>00173 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg, <span class="stringliteral">"\nPress any key to add a floating alarm"</span>);
<a name="l00174"></a>00174 gConsole->Printf(KConsoleMsg);
<a name="l00175"></a>00175 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg2,<span class="stringliteral">"\nWhen notification occurs, press Clear to continue"</span>);
<a name="l00176"></a>00176 gConsole->Printf(KConsoleMsg2);
<a name="l00177"></a>00177 gConsole->Getch();
<a name="l00178"></a>00178 gConsole->Printf(KConsoleStars);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 TASShdAlarm alarm;
<a name="l00181"></a>00181 alarm.Category() = KASCliCategoryClock;
<a name="l00182"></a>00182 <span class="comment">// Alarm occurs once, today. This is the default.</span>
<a name="l00183"></a>00183 alarm.RepeatDefinition() = EAlarmRepeatDefintionRepeatOnce;
<a name="l00184"></a>00184 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KAlarmMessage,<span class="stringliteral">"\nThis is a floating alarm."</span>);
<a name="l00185"></a>00185 alarm.Message() = KAlarmMessage;
<a name="l00186"></a>00186 <span class="comment">// Get the local time and set it as the alarm's due time</span>
<a name="l00187"></a>00187 alarm.NextDueTime().HomeTime();
<a name="l00188"></a>00188 <span class="comment">// Set alarm to expire in the past - should go off immediately.</span>
<a name="l00189"></a>00189 <span class="comment">// Note that if the alarm was of type EAlarmRepeatDefintionRepeatNext24Hours</span>
<a name="l00190"></a>00190 <span class="comment">// it would expire tomorrow.</span>
<a name="l00191"></a>00191 alarm.NextDueTime() -= TTimeIntervalSeconds(2);
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="comment">// WriteUserData capability is required to add an alarm</span>
<a name="l00194"></a>00194 User::LeaveIfError(iAlarmServerSession.AlarmAdd(alarm));
<a name="l00195"></a>00195 <span class="comment">// Wait for the user to clear the alarm</span>
<a name="l00196"></a>00196 WaitForAlarmToBeCleared();
<a name="l00197"></a>00197 }
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="comment">// Displays the state of the alarm</span>
<a name="l00200"></a>00200 <span class="keywordtype">void</span> CExampleAlarmServer::DisplayAlarmState(TAlarmState aState)
<a name="l00201"></a>00201 {
<a name="l00202"></a>00202 <span class="keywordflow">switch</span> (aState)
<a name="l00203"></a>00203 {
<a name="l00204"></a>00204 <span class="keywordflow">case</span> EAlarmStateInPreparation:
<a name="l00205"></a>00205 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg1, <span class="stringliteral">"\nThe alarm state is not currently known by the alarm server.."</span>);
<a name="l00206"></a>00206 gConsole->Printf(KConsoleMsg1);
<a name="l00207"></a>00207 <span class="keywordflow">break</span>;
<a name="l00208"></a>00208 <span class="keywordflow">case</span> EAlarmStateQueued:
<a name="l00209"></a>00209 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg2, <span class="stringliteral">"\nThe alarm is in the queue."</span>);
<a name="l00210"></a>00210 gConsole->Printf(KConsoleMsg2);
<a name="l00211"></a>00211 <span class="keywordflow">break</span>;
<a name="l00212"></a>00212 <span class="keywordflow">case</span> EAlarmStateSnoozed:
<a name="l00213"></a>00213 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg3, <span class="stringliteral">"\nThe alarm is snoozed. When the snooze period is over, the alarm expires again."</span>);
<a name="l00214"></a>00214 gConsole->Printf(KConsoleMsg3);
<a name="l00215"></a>00215 <span class="keywordflow">break</span>;
<a name="l00216"></a>00216 <span class="keywordflow">case</span> EAlarmStateWaitingToNotify:
<a name="l00217"></a>00217 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg4, <span class="stringliteral">"\nThe alarm is waiting to be notified."</span>);
<a name="l00218"></a>00218 gConsole->Printf(KConsoleMsg4);
<a name="l00219"></a>00219 <span class="keywordflow">break</span>;
<a name="l00220"></a>00220 <span class="keywordflow">case</span> EAlarmStateNotifying:
<a name="l00221"></a>00221 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg5, <span class="stringliteral">"\nThe alarm is currently notifying"</span>);
<a name="l00222"></a>00222 gConsole->Printf(KConsoleMsg5);
<a name="l00223"></a>00223 <span class="keywordflow">break</span>;
<a name="l00224"></a>00224 <span class="keywordflow">case</span> EAlarmStateNotified:
<a name="l00225"></a>00225 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg6, <span class="stringliteral">"\nThe alarm has already notified and has been dismissed."</span>);
<a name="l00226"></a>00226 gConsole->Printf(KConsoleMsg6);
<a name="l00227"></a>00227 <span class="keywordflow">break</span>;
<a name="l00228"></a>00228 }
<a name="l00229"></a>00229 }
<a name="l00230"></a>00230
<a name="l00231"></a>00231
<a name="l00232"></a>00232 <span class="comment">// Sets a fixed alarm and adds it to the alarmserver's queue.</span>
<a name="l00233"></a>00233 <span class="comment">// This is an alarm that is set using UTC, so will not change if </span>
<a name="l00234"></a>00234 <span class="comment">// for instance the system time zone changes.</span>
<a name="l00235"></a>00235 <span class="comment">// This function fetches and prints alarm details.</span>
<a name="l00236"></a>00236 <span class="keywordtype">void</span> CExampleAlarmServer::AddFetchDeleteFixedAlarmL()
<a name="l00237"></a>00237 {
<a name="l00238"></a>00238 gConsole->Printf(KConsoleStars);
<a name="l00239"></a>00239 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMsg, <span class="stringliteral">"\nPress any key to add a fixed alarm"</span>);
<a name="l00240"></a>00240 gConsole->Printf(KConsoleMsg);
<a name="l00241"></a>00241 gConsole->Getch();
<a name="l00242"></a>00242
<a name="l00243"></a>00243 TASShdAlarm alarm;
<a name="l00244"></a>00244 TAlarmCategory alarmCategory = KASCliCategoryClock;
<a name="l00245"></a>00245 alarm.Category()=alarmCategory;
<a name="l00246"></a>00246 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KAlarmMessage, <span class="stringliteral">"This is a fixed alarm"</span>);
<a name="l00247"></a>00247 alarm.Message() = KAlarmMessage;
<a name="l00248"></a>00248 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KAlarmSound, <span class="stringliteral">"Chimes"</span>);
<a name="l00249"></a>00249 alarm.SoundName() = KAlarmSound;
<a name="l00250"></a>00250 <span class="comment">// Alarm occurs once. </span>
<a name="l00251"></a>00251 alarm.RepeatDefinition() = EAlarmRepeatDefintionRepeatOnce;
<a name="l00252"></a>00252
<a name="l00253"></a>00253 TTime time;
<a name="l00254"></a>00254 <span class="comment">// Time is set in UTC for a fixed alarm </span>
<a name="l00255"></a>00255 time.UniversalTime();
<a name="l00256"></a>00256 <span class="comment">// Set alarm to expire in 2 seconds. </span>
<a name="l00257"></a>00257 time += TTimeIntervalSeconds(2);
<a name="l00258"></a>00258 alarm.SetUtcNextDueTime(time);
<a name="l00259"></a>00259
<a name="l00260"></a>00260 <span class="comment">// WriteUserData capability is required to add an alarm</span>
<a name="l00261"></a>00261 User::LeaveIfError(iAlarmServerSession.AlarmAdd(alarm));
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="comment">// Fetch some details about the alarm from the server and print them</span>
<a name="l00264"></a>00264 <span class="keyword">const</span> TAlarmId <span class="keywordtype">id</span> = alarm.Id();
<a name="l00265"></a>00265 TAlarmCategory category;
<a name="l00266"></a>00266 User::LeaveIfError(iAlarmServerSession.GetAlarmCategory(<span class="keywordtype">id</span>, category));
<a name="l00267"></a>00267 User::LeaveIfError(iAlarmServerSession.GetAlarmDetails(<span class="keywordtype">id</span>, alarm));
<a name="l00268"></a>00268
<a name="l00269"></a>00269 TAlarmState state = alarm.State();
<a name="l00270"></a>00270 DisplayAlarmState(state);
<a name="l00271"></a>00271
<a name="l00272"></a>00272 TAlarmMessage message = alarm.Message();
<a name="l00273"></a>00273 TBuf<256> messageBuf;
<a name="l00274"></a>00274 messageBuf.Copy(message);
<a name="l00275"></a>00275 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMessage,<span class="stringliteral">"\nThe alarm's message is....:"</span>);
<a name="l00276"></a>00276 gConsole->Printf(KConsoleMessage);
<a name="l00277"></a>00277 gConsole->Printf(messageBuf);
<a name="l00278"></a>00278
<a name="l00279"></a>00279 TAlarmSoundName soundName = alarm.SoundName();
<a name="l00280"></a>00280 messageBuf.Copy(soundName);
<a name="l00281"></a>00281 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleSoundName,<span class="stringliteral">"\nThe alarm's sound name is ....:"</span>);
<a name="l00282"></a>00282 gConsole->Printf(KConsoleSoundName);
<a name="l00283"></a>00283 gConsole->Printf(messageBuf);
<a name="l00284"></a>00284
<a name="l00285"></a>00285 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KDeleteMsg, <span class="stringliteral">"\n\nPress any key to finish"</span>);
<a name="l00286"></a>00286 gConsole->Printf(KDeleteMsg);
<a name="l00287"></a>00287 gConsole->Getch();
<a name="l00288"></a>00288
<a name="l00289"></a>00289 User::LeaveIfError(iAlarmServerSession.AlarmDelete(<span class="keywordtype">id</span>));
<a name="l00290"></a>00290 }
<a name="l00291"></a>00291
<a name="l00292"></a>00292
<a name="l00293"></a>00293 <span class="keywordtype">void</span> CExampleAlarmServer::EgAlarmServerL()
<a name="l00294"></a>00294 {
<a name="l00295"></a>00295 SetFloatingAlarmL();
<a name="l00296"></a>00296 AddFetchDeleteFixedAlarmL();
<a name="l00297"></a>00297 }
<a name="l00298"></a>00298
<a name="l00299"></a>00299 <span class="keyword">static</span> <span class="keywordtype">void</span> DoExampleL()
<a name="l00300"></a>00300 {
<a name="l00301"></a>00301 <span class="comment">// Create the console to print the messages to.</span>
<a name="l00302"></a>00302 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsoleMessageDisplay, <span class="stringliteral">"Alarm Server Example"</span>);
<a name="l00303"></a>00303 gConsole = Console::NewL(KConsoleMessageDisplay,TSize(KConsFullScreen,KConsFullScreen));
<a name="l00304"></a>00304 CleanupStack::PushL(gConsole);
<a name="l00305"></a>00305 gConsole->Printf(KConsoleMessageDisplay);
<a name="l00306"></a>00306 gConsole->Printf(KConsoleStars);
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <a class="code" href="class_c_example_alarm_server.html">CExampleAlarmServer</a>* egAlarmServer= CExampleAlarmServer::NewL();
<a name="l00309"></a>00309 TRAPD(err, egAlarmServer->EgAlarmServerL());
<a name="l00310"></a>00310 <span class="keywordflow">if</span> (err)
<a name="l00311"></a>00311 {
<a name="l00312"></a>00312 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KFailed,<span class="stringliteral">"\n\nExample failed: leave code=%d"</span>);
<a name="l00313"></a>00313 gConsole->Printf(KFailed, err);
<a name="l00314"></a>00314 gConsole->Getch();
<a name="l00315"></a>00315 }
<a name="l00316"></a>00316 <span class="keyword">delete</span> egAlarmServer;
<a name="l00317"></a>00317 CleanupStack::PopAndDestroy(gConsole);
<a name="l00318"></a>00318 }
<a name="l00319"></a>00319
<a name="l00320"></a>00320 <span class="comment">// Standard entry point function</span>
<a name="l00321"></a>00321 TInt E32Main()
<a name="l00322"></a>00322 {
<a name="l00323"></a>00323 __UHEAP_MARK;
<a name="l00324"></a>00324 <span class="comment">// Active scheduler required as this is a console app</span>
<a name="l00325"></a>00325 CActiveScheduler* scheduler=<span class="keyword">new</span> CActiveScheduler;
<a name="l00326"></a>00326 <span class="comment">// If active scheduler has been created, install it.</span>
<a name="l00327"></a>00327 <span class="keywordflow">if</span> (scheduler)
<a name="l00328"></a>00328 {
<a name="l00329"></a>00329 CActiveScheduler::Install(scheduler);
<a name="l00330"></a>00330 <span class="comment">// Cleanup stack needed</span>
<a name="l00331"></a>00331 CTrapCleanup* cleanup=CTrapCleanup::New();
<a name="l00332"></a>00332 <span class="keywordflow">if</span> (cleanup)
<a name="l00333"></a>00333 {
<a name="l00334"></a>00334 TRAP_IGNORE(DoExampleL());
<a name="l00335"></a>00335 <span class="keyword">delete</span> cleanup;
<a name="l00336"></a>00336 }
<a name="l00337"></a>00337 <span class="keyword">delete</span> scheduler;
<a name="l00338"></a>00338 }
<a name="l00339"></a>00339 __UHEAP_MARKEND;
<a name="l00340"></a>00340 <span class="keywordflow">return</span> KErrNone;
<a name="l00341"></a>00341 }
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>