AdjustMessageTimeout

Type

EXS SwitchKit API message

Purpose

Use the SK_AdjustMessageTimeout message to change the default time-out for responses.

Description

SwitchKit allows all requests to the Excel platform a fixed amount of time to complete before the request is considered timed out. For most messages, this time is 15 seconds which is often acceptable for these SwitchKit-defined time-outs. However, there are times when the time-out specified is insufficient. In particular, when several time consuming messages are sent to the same node simultaneously, the time to complete a request can increase due to latency within the Excel platform. These increased delays occur primarily during configuration time.

The AdjustMessageTimeout message increases the time-out for all messages by TimeoutIncr. In other words, if an application requested that the time-out be adjusted by 10 seconds, the time-out on most messages sent by that application would become 25 seconds. Messages that have a larger default time-out would have their time-out increased by the same 10 seconds.

You must set the Action field for SK_AMT_ACTIVATE_TIMEOUT, to activate a new time-out. To set this new time-out for all applications connected to the LLC, set the NumApps field to SK_ALL_APPS. If you attempt to set a new time-out for only one application, don’t set the NumApps field.

You can reset the time-out by setting the Action field to SK_AMT_DEACTIVATE_TIMEOUT.

Sent by

Application

Arguments

The following table shows the user modifiable arguments of the AdjustMessageTimeout message:

Argument

Description

Action

Action specifies whether a new timeout gets activated or deactivated.

TimeoutIncr

TimeoutIncr specifies the amount of time added to the prior timeout value.

NumApps

NumApps specifies whether the new timeout gets set for only one or all messages.

Configuration

AdjustMessageTimeout (

Node = integer,

ConnectionID = integer,

Action = integer,

TimeoutIncr = integer,

NumApps = integer);

C Structure

typedef struct {

UBYTE Action;

unsigned short TimeoutIncr;

UBYTE NumApps;

} SK_AdjustMessageTimeout;

C Structure Response

typedef struct {

int Status;

} SK_AdjustMessageTimeoutAck;

C++ Class

class SKC_AdjustMessageTimeout : public SKC_ToolkitMessage {

public:

UBYTE getAction() const;

void setAction(UBYTE x);

unsigned short getTimeoutIncr() const;

void setTimeoutIncr(unsigned short x);

UBYTE getNumApps() const;

void setNumApps(UBYTE x);

};

C++ Class Response

class SKC_AdjustMessageTimeoutAck : public SKC_ToolkitAck {

public:

int getStatus() const;

void setStatus(int x);

};