You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ConfigStatusMsg

ConfigStatusMsg

Type:

SwitchKit API message

Purpose

SwitchManager sends the SK_ConfigStatusMsg message to a registered application at configuration time.

An application can register to receive this message when SwitchManager configures the entire CSP or a part of an CSP configuration, including start-up, a dynamic change request, or a matrix failure. SwitchManager tracks when the configuration begins, when it ends, and the number of positive and negative ACKs received.

To receive the message SK_ConfigStatusMsg, your application must register for this message using the sk_msgRegister() function. The application should not send an acknowledgement for this message.

If SwitchManager is run with -s option and if there was no configuration message sent to the CSP, SwitchManager will not send any SK_ConfigStatusMsg.

Sent by

SwitchManager

C Structure

typedef struct {

UBYTE Event;

UBYTE ConfigType;

int NumMsgsSent;

int NumMsgsNacked;

} SK_ConfigStatusMsg;

C++ Class

class SKC_ConfigStatusMsg : public SKC_ToolkitMessage {

public:

UBYTE getEvent() const;

void setEvent(UBYTE x);

UBYTE getConfigType() const;

void setConfigType(UBYTE x);

int getNumMsgsSent() const;

void setNumMsgsSent(int x);

int getNumMsgsNacked() const;

void setNumMsgsNacked(int x);

};

Field Values

The following table shows the possible field values of this message:

Field | Values and Description
--- | ---
Event | • SK_BEGIN_CONFIG = indicates SwitchManager began a configuration. • SK_END_CONFIG = indicates SwitchManager finished the configuration. • SK_PARSE_ERROR = indicates an error occurred when parsing the configuration.
ConfigType | This field indicates the reason the configuration takes place. Possible reasons are: SK_INITIAL_CONFIG SK_DYNAMIC_CONFIG SK_MATRIX_STATE SK_RECEIPT_OF_NSR SK_CONFIG_TAG_RESET SK_CARD_RECONFIG SK_CARD_FAILURE
NumMsgsSent | This field indicates the number of messages sent to the CSP through SwitchManager.
NumMsgsNacked | This field indicates the number of messages that have been negatively acknowledged by the CSP. If a config message gets a nack with status "No Ack From Switch" or "Card Not ready for configuration", SwitchManager will try to re-send the config message several times before quitting. This would be reflected on the NumMsgsSent and NumMsgsNacked fields.
Slot | SK_CARD_FAILURE SK_CARD_RECONFIG SK_CONFIG_TAG_RESET
CardType | SK_CARD_FAILURE SK_CARD_RECONFIG SK_CONFIG_TAG_RESET

Relevant Attributes to ConfigType

ConfigType | Attributes
SK_MATRIX_STATE | Node
SK_DYNAMIC_CONFIG | Nothing
SK_RECEIPT_OF_NSR | Node
SK_CARD_FAILURE | Node, Slot, CardType
SK_CARD_RECONFIG | Node, Slot, CardType
SK_CONFIG_TAG_RESET | Node, Slot, CardType