Alarm Class Reference

#include <Alarm.h>

List of all members.

---

Detailed Description

Provide static interface for application code to report alarm conditions.

Static Public Member Functions
static void	raiseAlarm (UtlString alarmId)
	Send an alarm to the Alarm Server without any runtime parameter. Non-blocking. The Alarm Server is configured in sipxsupervisor-config, so any process generating an alarm using this interface should declare sipxsupervisor-config as a resource.
static void	raiseAlarm (UtlString alarmId, UtlString alarmParam)
	Alarms are identified by a unique alarm ID, which is not visible to the customer.
static void	raiseAlarm (UtlString alarmId, UtlSList &alarmParams)
	Send an alarm to the Alarm Server with a list of runtime parameters. Non-blocking.

---

Member Function Documentation

void raiseAlarm

(

UtlString

alarmId

)

[static]

Send an alarm to the Alarm Server without any runtime parameter. Non-blocking. The Alarm Server is configured in sipxsupervisor-config, so any process generating an alarm using this interface should declare sipxsupervisor-config as a resource.

Parameters:

alarmId

internal unique alarm ID

void raiseAlarm	(	UtlString	alarmId,
		UtlString	alarmParam
	)			[static]

Alarms are identified by a unique alarm ID, which is not visible to the customer.

Configuration data for new alarms are added by editing the alarm xml files in sipXsupervisor/etc. Send an alarm to the Alarm Server with a single runtime parameter. Non-blocking.

Parameters:

alarmId	internal unique alarm ID
alarmParam	string containing single runtime parameter

void raiseAlarm	(	UtlString	alarmId,
		UtlSList &	alarmParams
	)			[static]

Send an alarm to the Alarm Server with a list of runtime parameters. Non-blocking.

Parameters:

alarmId	internal unique alarm ID
alarmParams	vector of strings containing runtime parameters