Channel Connection Status Query 0x0001

SwitchKit Name

ChannelConnectionStatusQuery

Type

EXS API and SwitchKit API message

Description

Channel Connection Status Query 0x0001

Use this message to retrieve a channel’s connection status.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

UBYTE Channel;

} XL_ChannelConnectionStatusQuery;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short SpanA;

UBYTE ChannelA;

unsigned short SpanB;

UBYTE ChannelB;

UBYTE ChannelAState;

} XL_ChannelConnectionStatusQueryAck;

C++ Class

class XLC_ChannelConnectionStatusQuery : public XLC_OneChannelOutbound {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

};

C++ Class Response

class XLC_ChannelConnectionStatusQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

unsigned short getSpanA() const;

void setSpanA(unsigned short x);

UBYTE getChannelA() const;

void setChannelA(UBYTE x);

unsigned short getSpanB() const;

void setSpanB(unsigned short x);

UBYTE getChannelB() const;

void setChannelB(UBYTE x);

UBYTE getChannelAState() const;

void setChannelAState(UBYTE x);

};

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (MSB, LSB) 0x00NN

1, 2

Length (MSB, LSB) 0x00NN

3, 4

Message Type (0x0001)

3, 4

Message Type (0x0001)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB

Address Method

0x00 - Individual AEs

8, 9

Status (MSB, LSB)

0x0010
Logical Span ID A, Channel A is
connected to Logical Span ID B,
Channel B.


0x0015
Logical Span ID A, Channel A is not
connected.

Number of AEs to follow

AEs

0x0D Channel A

0x0D Channel B

:

Checksum

:

AIB

Same as message

 

Response continued below.

:

Channel A State

This field indicates the call processing state for Layer 4:

 

If the preceding Status field is a positive acknowledgement, this field does not apply.

 

0x00 Out-of-service

0x03 Idle

0x04 Host Connect Wait

0x05 Outseize ACK Network Wait

0x07 Answered/connected

0x08 Layer 4 Release Wait

0x09 Network Release Wait

0x0A Busied Out

0x0B Externally Outseized

0x0C Hold Acknowledge Wait

0x0D Layer 3 Answer Wait

0x0E Layer 4 Answer Wait

0x10 Layer 4 Recall Wait

0x11 Purge Response Wait

0x12 Purge Wait

0x13 Park

0x14 Layer 4 Connection Clear Wait

0x1D Outgoing Call

:

Checksum