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

AppConnectionQuery

Type

SwitchKit API message

Purpose

Use the AppConnectionQuery message to query the Low-Level Communicator (LLC) for description data of a specific application.

Description

The message is for querying the LLC for description data of a specific application. All of the data is returned in AppConnectionQueryAck. In addition to returning the application IDs of connected applications, an acknowledgement will also contain the application IDs of the primary LLC and redundant LLC.

Sent by

Application

How to use

To use an AppConnectionQuery message construct the message and set the application ID:

SKC_AppConnectionQuery acq;

acq.setAppID(app_id);

Arguments

The following table shows the user modifiable argument:

Argument | Description
--- | ---
AppID | Specifies the name of the specific application.

Status Field

The following table shows the possible return values of the status field:

Value | Description
--- | ---
OK | Query successfully acknowledged
SK_NO_ACK_FROM_ SWITCH | CSP did not respond.
SK_UNKNOWN_APP | You used an unknown AppID. This indicates that no application with the specified ID is connected to the LLC.
SK_NO_APP_DATA | Indicates that the application has no description data associated with it.

C Structure

typedef struct {

int AppID;

} SK_AppConnectionQuery;

C Structure Response

typedef struct {

int Status;

int AppID;

char AppName[80];

char AppVersion[16];

int PID;

char Hostname[32];

char StartTime[32];

char SkVersion[16];

char UserData[50];

} SK_AppConnectionQueryAck;

C++ Class

class SKC_AppConnectionQuery : public SKC_ToolkitMessage {

public:

int getAppID() const;

void setAppID(int x);

};

C++ Class Response

class SKC_AppConnectionQueryAck : public SKC_ToolkitAck {

public:

int getStatus() const;

void setStatus(int x);

int getAppID() const;

void setAppID(int x);

const char *getAppName() const;

void setAppName(const char *x);

const char *getAppVersion() const;

void setAppVersion(const char *x);

int getPID() const;

void setPID(int x);

const char *getHostname() const;

void setHostname(const char *x);

const char *getStartTime() const;

void setStartTime(const char *x);

const char *getSkVersion() const;

void setSkVersion(const char *x);

const char *getUserData() const;

void setUserData(const char *x);

};

Positive acknowledgment to a message