ConnectionStatusMsg

Type:

EXS SwitchKit API message

Description

This message is sent by the Low-Level Communicator (LLC) to an application whenever any application connects to or disconnects from the LLC. These notifications go to applications. All applications connect to LLC. By default, LLC will send ConnectionStatusMsg messages to all applications. To disable this functionality, set SK_DISABLE_CSM =1.

This feature is used, for example, to detect whether an application in a redundant pair disconnects. This includes notification of an LLC or SwitchManager switchover. In a redundant LLC set-up, if the primary LLC fails, a ConnectionStatusMsg is sent, stating that an application with the LLC name of ‘0’ has disconnected. The ‘0’ corresponds to the primary LLC.

There are two types of applications:

Special Applications

– SwitchManger and Redundant LLC (RLLC) are special applications. SwitchManger always connects to the LLC as the application named 1. RLLC always connects to the LLC as the application named 2.

User Applications

– User applications, including the Converged Services Administrator, connect to the LLC as applications with names greater than or equal to 10.

In a redundant LLC set-up, if the primary LLC (PLLC) fails, a ConnectionStatusMsg is sent, stating that an application with the LLC name of ‘0’ has disconnected. The ‘0’ corresponds to the primary LLC.

Sent by

Application

C Structure

typedef struct {

char IPAddress[50];

UBYTE Status;

int Name;

UBYTE reserved72[4];

} SK_ConnectionStatusMsg;

C++ Class

class SKC_ConnectionStatusMsg : public SKC_ToolkitInbound {

public:

const char *getIPAddress() const;

void setIPAddress(const char *x);

UBYTE getStatus() const;

void setStatus(UBYTE x);

int getName() const;

void setName(int x);

};

Argument Values

The following table shows the possible values for the arguments of this message:

Argument

Value

Description

Status

SK_CSM_Dropped

Indicates the application has disconnected.

SK_CSM_Connected

Indicates the application has connected.

SK_CSM_RLLC_Dropped

If the RLLC boots an application, this value is used to reconnect to the PLLC. The application did not close, but is reconnects to the PLLC. (The previously sent out message was a SK_CSM_Dropped message.)

SK_CSM_Reconnected

This is sent when an application reconnects to an LLC, either because it was disconnected and reconnected within the 15 second time-out period, or there was a switchover from the PLLC to the RLLC. (Previously sent out message was a SK_CSM_Connected message.)

SK_CSM_App_Reconnected

The user application has reconnected to the LLC/RLLC.

Name

The LLC name (i.e. integer) associated with the application

The LLC name (i.e. integer) associated with the application.

IPAddress

IP address of the client that the LLC sees the incoming socket connecting from.

IP address of the client that the LLC sees the incoming socket connecting from.