SccpAlarmControl

Controls the level of alarms generated by the SCCP task on the TX board.

Prototype

SCCP_STATUS SccpAlarmControl ( U8 board, U8 alarmLvl)

Argument

Description

board

TX board number.

alarmLvl

Desired new alarm level. SCCP defines the following alarm levels. Refer to the Details section for more information.

0 = SCCP_ALARMLVL_DISABLE

1 = SCCP_ALARMLVL_DEFAULT

2 = SCCP_ALARMLVL_DEBUG

3 = SCCP_ALARMLVL_DETAIL


Return values

Return value

Description

SCCP_SUCCESS

 

SCCP_BOARD

board is out of range.

SCCP_DRIVER

Error occurred accessing the driver.

SCCP_NOGENCFG

SccpSetGenCfg has not been called.

SCCP_RANGE

alarmLvl is out of range.

SCCP_TIMEOUT

Request timed out.

SCCP_UNINIT

Application failed to call SccpMgmtInit prior to this call.


Details

All SCCP alarm messages are sent to the txalarm utility. The following table defines the SCCP alarm levels and their recommended use:

Alarm level

Description

SCCP_ALARMLVL_DISABLE

All alarms are disabled. This alarm level is not recommended for use.

SCCP_ALARMLVL_DEFAULT

Default alarm level. Service impacting events such as application/SSN unavailable, resource failures, and application interface violations are logged.

SCCP_ALARMLVL_DEBUG

All default level 1 alarms plus detailed message encoding or decoding diagnostics to troubleshoot individual application or transaction problems. Use this alarm level for application development.

SCCP_ALARMLVL_DETAIL

All debug level 2 alarms plus some normal events to help isolate network or application problems. Do not use this alarm level under production load conditions.