asaltdefs.h File Reference

Typedef TASAltClientServerStateFlags

typedef TBitFlags TASAltClientServerStateFlags

Flags used to indicate the States for enum TASAltStateFlags

KASAltVersionMajor

const TIntKASAltVersionMajor

Major Version used while connecting to the Alarm Alert Server

KASAltVersionMinor

const TIntKASAltVersionMinor

Minor Version used while connecting to the Alarm Alert Server

KASAltVersionBuild

const TIntKASAltVersionBuild

Build Version used while connecting to the Alarm Alert Server

KAlmMessageSlots

const TIntKAlmMessageSlots

Number of message Slots

Enum TASAltOpCode

The individual op codes which the Alert Server and Alarm Server handshake using

EnumeratorValueDescription
EASAltOpCodeNotify0

Notify the alarm server (asynchronously) when the Alert Server wishes to perform some action.

EASAltOpCodeNotifyCancel

Cancel an earlier notification

EASAltOpCodeVisible

Change the visibility of the Alert Server UI furniture

EASAltOpCodeSetState

Update the Alert Server flags

EASAltOpCodeSetAlarm

Inform the Alert Server of the currently notifying alarm

EASAltOpCodeSetDeferTime

Inform the Alert Server that the currently alerting alarm has been snoozed.

EASAltOpCodeGetUserTime

Retrieve the time from the Alert Server when a quiet period should be terminated

EASAltOpCodeLogon

Create an outstanding request with the Alert Server. Used as a mechanism to obtain Alert Server thread death notifications.

EASAltOpCodeStartPlayingSound

Ask the Alert Server to start playing the specified alarm sound

EASAltOpCodeStopPlayingSound

Ask the Alert Server to stop playing any sound Ask the Alert Server to change vissibility for all alarms

EASAltOpCodeVisibleAll
EASAltOpCodeSetStateAll

Ask the Alert Server to update states for all alarms

EASAltOpCodeStopPlayingSoundAll

Ask the Alert Server to stop playing all sounds.

EASAltOpCodeDeleteAlarm

Ask the Alert Server to delete alarm with provided Id

EASAltOpCodeGetEndQuietTime

Retrieve the time from the Alert Server when a quiet period should be terminated

EASAltOpCodeGetMaxAlarms

Ask the Alarm Server to get number of simultaneously supported alarms

EASAltOpCodeDeleteAlarmAll

Ask the Alert Server to delete all alarms

EASAltOpCodeLast

Enum TASAltAlertServerResponse

All communication from the Alert Server to the Alarm Server occurs via a single outstanding TRequesStatus which is handled by the Alarm Server (as an active object). This enumeration describes the type of action that the Alarm Server should take in response to a request from the Alert Server.

EnumeratorValueDescription
EASAltAlertServerResponseSilence0

The Alert Server wishes the Alarm Server to silence all alarms.

EASAltAlertServerResponseQuietPeriod

The Alert Server wishes the Alarm Server to enter a global quiet period.

EASAltAlertServerResponseClear

The Alert Server wishes the Alarm Server to acknowledge (clear) the currently notifying alarm.

EASAltAlertServerResponseClearAll

The Alert Server wishes the Alarm Server to acknowledge (clear) the currently notifying alarm and all others that are awaiting notification.

EASAltAlertServerResponseSnooze

The Alert Server wishes the Alarm Server to snooze the currently notifying alarm.

EASAltAlertServerResponsePauseSound

The Alert Server wishes the Alarm Server to temporarily pause all sound (i.e stop sending sound play events to the Alert Server).

Enum TASAltStateFlags

Flags for TASAltClientServerStateFlags

EnumeratorValueDescription
EASAltStateFlagsSilentRunning1

The Alert Server should not play any sound

EASAltStateFlagsInQuietPeriod2

The Alarm Server is currently within a quiet period

EASAltStateFlagsMoreThanOneDueAlarm3

The Alarm Server currently has more than one alarm ready to notify.

EASAltStateFlagsNoMemoryForSnoozeAlarm4

There wasn't sufficient memory within the Alarm Server to allocate room for a snoozed alarm. I'm note convinced we need this anymore

EASAltStateFlagsAlarmHasNoSoundFileName5

There isn't any sound filename for the current alarm.

EASAltStateFlagsSoundIsPaused6

This isn't used by the Alert Server.

_LIT ( KAlarmAlertServerName, "!AlarmAlertServer" )

_LIT(KAlarmAlertServerName,
"!AlarmAlertServer"
)