Virtual Span Control 0x00E2

SwitchKit Name

VirtualSpanControl

Type

EXS API and SwitchKit API message

Description

This message is used by the host to indicate to the Excel platform the Layer 1 state of a Virtual Span.

Sent

Host

Example Message

The following example brings all virtual spans in the node into service.

00 0E 00 E2 00 00 FF 00 01 0C 02 00 00 00 01 00

SwitchKit Code

Configuration

VirtualSpanControl (

Node = integer,

Span = integer,

Event = integer,

Data = byte array);

C Structure

typedef struct {

unsigned short Span;

UBYTE reserved19[28];

unsigned short Event;

UBYTE Data[221];

} XL_VirtualSpanControl;

C++ Class

class XLC_VirtualSpanControl : public XLC_SpanMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

unsigned short getEvent() const;

void setEvent(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(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 (0xNNNN)

1, 2

Length (0xNNNN)

3, 4

Message Type (0x00E2)

3, 4

Message Type (0x00E2)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

:

AIB

Address Method

0x01 Individual

8, 9

Status MSB, LSB

0x0012 Invalid Span

Invalid Span was passed from host.

0x001D Invalid Event Type

Host specified an invalid event type.
0x0063 Unassigned Span

The logical span specified has not
been assigned.

Number of AEs to follow

0x01

10

 

Checksum

AEs

0x0C Logical Span

:

Event MSB, LSB

0x00 Span is Non-operational
(same as Loss of Signal
at Layer 1)

0x01 Span is Operational
(same as No Loss of
Signal at Layer 1)

:

Data[0]
ICB Count. This should always
be sent from the host as 0x00.

:

Checksum