You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ChannelProblem
Type:
EXS SwitchKit API message
Description
This message is generated by SwitchManager. To do this, SwitchManager must be running in order for an application to receive a channel problem message. An application can receive a message when a channel has encountered some problems, but has not gone out-of-service. The application also receives this message when the problem clears.
ErrorNum equals one (1) if a red or yellow span alarm occurs; or equals two (2) if a PPL Event Indication occurs. The LLC does not allocate a channel that is in an alarm state, but if an application already has a channel that has entered into an alarm state, the application must deal with this state. Text will contain a description of the problem, which in the case of red and yellow alarms is a description of the current network status. A problem with a value of one (1) means the problem just occurred; a value of zero (0) means the problem has cleared. In the case of a span alarm, Data1 will equal the status field extracted from the EXS API message. In the case of a PPL Event Indication, Data1 will equal the PPL Event.
Sent by
SwitchManager; forwarded by LLC
C Structure
typedef struct {
unsigned short Span;
UBYTE Channel;
UBYTE Problem;
UBYTE ErrorNum;
UBYTE Data1;
UBYTE Data2;
char Text[200];
} SK_ChannelProblem;
C++ Class
class SKC_ChannelProblem : public SKC_ToolkitMessage {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getProblem() const;
void setProblem(UBYTE x);}
UBYTE getErrorNum() const;
void setErrorNum(UBYTE x);
UBYTE getData1() const;
void setData1(UBYTE x);
UBYTE getData2() const;
void setData2(UBYTE x);
const char *getText() const;
void setText(const char *x);
};