1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/asaltdefs.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,247 @@
1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __ASALTDEFS_H__
1.20 +#define __ASALTDEFS_H__
1.21 +
1.22 +/** @file
1.23 +@publishedAll
1.24 +@released
1.25 +*/
1.26 +// System includes
1.27 +#include <e32std.h>
1.28 +#include <babitflags.h>
1.29 +
1.30 +/**
1.31 + Flags used to indicate the States for enum TASAltStateFlags
1.32 + */
1.33 +typedef TBitFlags TASAltClientServerStateFlags;
1.34 +
1.35 +/**
1.36 + Major Version used while connecting to the Alarm Alert Server
1.37 + */
1.38 +const TInt KASAltVersionMajor = 3;
1.39 +
1.40 +/**
1.41 + Minor Version used while connecting to the Alarm Alert Server
1.42 + */
1.43 +const TInt KASAltVersionMinor = 0;
1.44 +
1.45 +/**
1.46 + Build Version used while connecting to the Alarm Alert Server
1.47 + */
1.48 +const TInt KASAltVersionBuild = 0;
1.49 +
1.50 +/**
1.51 + Number of message Slots
1.52 + */
1.53 +const TInt KAlmMessageSlots = 5;
1.54 +
1.55 +/**
1.56 + The individual op codes which the Alert Server and Alarm Server
1.57 + handshake using
1.58 + */
1.59 +enum TASAltOpCode
1.60 + {
1.61 + /**
1.62 + Notify the alarm server (asynchronously) when the Alert Server
1.63 + wishes to perform some action.
1.64 + */
1.65 + EASAltOpCodeNotify = 0,
1.66 +
1.67 + /**
1.68 + Cancel an earlier notification
1.69 + */
1.70 + EASAltOpCodeNotifyCancel,
1.71 +
1.72 + /**
1.73 + Change the visibility of the Alert Server UI furniture
1.74 + */
1.75 + EASAltOpCodeVisible,
1.76 +
1.77 + /**
1.78 + Update the Alert Server flags
1.79 + */
1.80 + EASAltOpCodeSetState,
1.81 +
1.82 + /**
1.83 + Inform the Alert Server of the currently notifying alarm
1.84 + */
1.85 + EASAltOpCodeSetAlarm,
1.86 +
1.87 + /**
1.88 + Inform the Alert Server that the currently alerting alarm
1.89 + has been snoozed.
1.90 + */
1.91 + EASAltOpCodeSetDeferTime,
1.92 +
1.93 + /**
1.94 + Retrieve the time from the Alert Server when a quiet period
1.95 + should be terminated
1.96 + */
1.97 + EASAltOpCodeGetUserTime,
1.98 +
1.99 + /**
1.100 + Create an outstanding request with the Alert Server. Used
1.101 + as a mechanism to obtain Alert Server thread death notifications.
1.102 + */
1.103 + EASAltOpCodeLogon,
1.104 +
1.105 + /**
1.106 + Ask the Alert Server to start playing the specified alarm sound
1.107 + */
1.108 + EASAltOpCodeStartPlayingSound,
1.109 +
1.110 + /**
1.111 + Ask the Alert Server to stop playing any sound
1.112 + */
1.113 + EASAltOpCodeStopPlayingSound
1.114 +
1.115 + /**
1.116 + Ask the Alert Server to change vissibility for all alarms
1.117 + */
1.118 + , EASAltOpCodeVisibleAll,
1.119 +
1.120 + /**
1.121 + Ask the Alert Server to update states for all alarms
1.122 + */
1.123 + EASAltOpCodeSetStateAll,
1.124 +
1.125 + /**
1.126 + Ask the Alert Server to stop playing all sounds.
1.127 + */
1.128 + EASAltOpCodeStopPlayingSoundAll,
1.129 +
1.130 + /**
1.131 + Ask the Alert Server to delete alarm with provided Id
1.132 + */
1.133 + EASAltOpCodeDeleteAlarm,
1.134 +
1.135 + /**
1.136 + Retrieve the time from the Alert Server when a quiet period
1.137 + should be terminated
1.138 + */
1.139 +
1.140 + EASAltOpCodeGetEndQuietTime,
1.141 +
1.142 + /**
1.143 + Ask the Alarm Server to get number of simultaneously supported alarms
1.144 + */
1.145 + EASAltOpCodeGetMaxAlarms,
1.146 +
1.147 + /**
1.148 + Ask the Alert Server to delete all alarms
1.149 + */
1.150 + EASAltOpCodeDeleteAlarmAll,
1.151 +
1.152 + EASAltOpCodeLast
1.153 +
1.154 +
1.155 + };
1.156 +
1.157 +/**
1.158 + All communication from the Alert Server to the Alarm Server
1.159 + occurs via a single outstanding TRequesStatus which is handled
1.160 + by the Alarm Server (as an active object). This enumeration
1.161 + describes the type of action that the Alarm Server should take in
1.162 + response to a request from the Alert Server.
1.163 + */
1.164 +enum TASAltAlertServerResponse
1.165 + {
1.166 + /**
1.167 + The Alert Server wishes the Alarm Server to
1.168 + silence all alarms.
1.169 + */
1.170 + EASAltAlertServerResponseSilence = 0,
1.171 +
1.172 + /**
1.173 + The Alert Server wishes the Alarm Server to
1.174 + enter a global quiet period.
1.175 + */
1.176 + EASAltAlertServerResponseQuietPeriod,
1.177 +
1.178 + /**
1.179 + The Alert Server wishes the Alarm Server to
1.180 + acknowledge (clear) the currently notifying alarm.
1.181 + */
1.182 + EASAltAlertServerResponseClear,
1.183 +
1.184 + /**
1.185 + The Alert Server wishes the Alarm Server to
1.186 + acknowledge (clear) the currently notifying alarm
1.187 + and all others that are awaiting notification.
1.188 + */
1.189 + EASAltAlertServerResponseClearAll,
1.190 +
1.191 + /**
1.192 + The Alert Server wishes the Alarm Server to
1.193 + snooze the currently notifying alarm.
1.194 + */
1.195 + EASAltAlertServerResponseSnooze,
1.196 +
1.197 + /**
1.198 + The Alert Server wishes the Alarm Server to
1.199 + temporarily pause all sound (i.e stop sending sound
1.200 + play events to the Alert Server).
1.201 + */
1.202 + EASAltAlertServerResponsePauseSound
1.203 + };
1.204 +
1.205 +/**
1.206 + Flags for TASAltClientServerStateFlags
1.207 + */
1.208 +enum TASAltStateFlags
1.209 + {
1.210 + /**
1.211 + The Alert Server should not play any sound
1.212 + */
1.213 + EASAltStateFlagsSilentRunning = 1,
1.214 +
1.215 + /**
1.216 + The Alarm Server is currently within a quiet period
1.217 + */
1.218 + EASAltStateFlagsInQuietPeriod = 2,
1.219 +
1.220 + /**
1.221 + The Alarm Server currently has more than one alarm
1.222 + ready to notify.
1.223 + */
1.224 + EASAltStateFlagsMoreThanOneDueAlarm = 3,
1.225 +
1.226 + /**
1.227 + There wasn't sufficient memory within the Alarm
1.228 + Server to allocate room for a snoozed alarm. I'm
1.229 + note convinced we need this anymore
1.230 + */
1.231 + EASAltStateFlagsNoMemoryForSnoozeAlarm = 4,
1.232 +
1.233 + /**
1.234 + There isn't any sound filename for the current
1.235 + alarm.
1.236 + */
1.237 + EASAltStateFlagsAlarmHasNoSoundFileName = 5,
1.238 +
1.239 + /**
1.240 + This isn't used by the Alert Server.
1.241 + */
1.242 + EASAltStateFlagsSoundIsPaused = 6
1.243 +
1.244 + };
1.245 +
1.246 +// Literal constants
1.247 +_LIT(KAlarmAlertServerName, "!AlarmAlertServer");
1.248 +
1.249 +
1.250 +#endif