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:

Relevant Attributes to ConfigType