PPL Create 0x00D4

SwitchKit Name

PPLCreate

Type

EXS API and SwitchKit API message

Description

This message is used to create a PPL protocol from previously downloaded state/event and primitive tables. The host assigns the protocol ID and uses it to identify the protocol in subsequent messages.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short ComponentID;

UBYTE ProtocolID;

char ProtocolName[20];

UBYTE NumTables;

UBYTE TableData[229];

} XL_PPLCreate;

C++ Class

class XLC_PPLCreate : public XLC_OutboundMessage {

public:

unsigned short getComponentID() const;

void setComponentID(unsigned short x);

UBYTE getProtocolID() const;

void setProtocolID(UBYTE x);

const char *getProtocolName() const;

void setProtocolName(const char *x);

UBYTE getNumTables() const;

void setNumTables(UBYTE x);

const UBYTE *getTableData() const;

UBYTE *getTableData();

void setTableData(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 (0x0007)

3, 4

Message Type (0x00D4)

3, 4

Message Type (0x00D4)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8, 9

PPL Component ID MSB, LSB

See PPL Component IDs in the
API Reference.

8, 9

Status MSB, LSB

10

PPL Protocol ID

Number assigned to the protocol
by the host (0x01–0x0A).

10

Checksum

11–30

PPL Protocol Name

A NULL-terminated ASCII string of up to 20 characters describing the protocol ("ITU-T Protocol"). You must pad any remaining byte offsets up to 20 with 0x00.

31

Number of Tables (n)

:

Table 1: Type

0x01 Primitive Table

0x02 State/Event Table

0x03 Route Table

0x04 Resource Group Table

:

Table 1: ID

Number assigned to the table by the host (0x01–0x0A).

:

Table n: Type

:

Table n: ID

:

Checksum