You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > PPL Event Indication 0x0043

PPL Event Indication 0x0043

SwitchKit Name

PPLEventIndication

Type

EXS API and SwitchKit API message

Description

PPL Event Indication 0x0043

This message is sent by a PPL component to report an event to the host with optional ICB data.

NOTE: All PPL Event Indication messages that originate with the CIC PPL component will have the new Virtual CIC AIB.

Sent by

CSP

Example Message (Socket Log Output for SwitchKit)

In this example, the CSP informs the host of an incoming
SIP REGISTER message:

00 0B 00 43 00 00 FF 7F 00 A7 00 0A 00

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

unsigned short ComponentID;

unsigned short PPLEvent;

UBYTE ICBCount;

UBYTE Data[218];

} XL_PPLEventIndication;

C++ Class

class XLC_PPLEventIndication : public XLC_InboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getSpan() const;

void setSpan(XBYTE x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

UBYTE getStackID() const;

void setStackID(UBYTE x);

UBYTE getLinkID() const;

void setLinkID(UBYTE x)

XBYTE getV5ID() const;

void setV5ID(XBYTE x);

unsigned short getComponentID() const;

void setComponentID(unsigned short x);

unsigned short getPPLEvent() const;

void setPPLEvent(unsigned short x);

UBYTE getICBCount() const;

void setICBCount(UBYTE 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 (0x00NN) | 1, 2 | Length (0x0005)
3, 4 | Message Type (0x0043) | 3, 4 | Message Type (0x0043)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method Depends on component being addressed. Number of AEs to follow AE The AE used depends on the component being addressed. See PPL Component Addressing in the API Reference. | 8 | Checksum
: | PPL Component ID MSB, LSB See PPL Component IDs in the API Reference.
: | PPL Event MSB, LSB
: | Number of ICBs to follow (Ignore this field if no ICBs in message.)
: | ICB 0x02 Data ICBs 0x10 ISDN Formatted IEs 0x11 ISDN Raw IEs 0x12 SS7 Parameters 0x14 PPL Argument 2 Data 0x15 DASS2/DPNSS Raw Data 0x16 SS7 Protocol Violation Data 0x1C SS7 TUP Formatted Fields 0x1E Generic PPL 0x1F SS7 Unformatted Raw Parameters 0x20 SS7 SCCP Parameters 0x21 SS7 TCAP Parameters 0x22 Raw SS7 Data Parameters 0x25 ISDN Segmented Message 0x51 Soft Register All Switch-Initiated Messages 0x5B IP Signaling Series 3 Card ID 0x5D H.323 DTMF Signal Input Received 0x5E H.323 Signal Update Input Received 0x5F H.323 Alphanumeric Input Received 0x62 Remote Endpoints UII Capabilities 0x65 TCAP Primitive 0x03 Extended Data ICBs 0x002D Q.752 Parameter 0x0012 SS7 Formatted Parameters 0x0026 Channel Pad Value 0x0029 V5 Formatted IEs 0x0030 V5 Statistics Data 0x0031 V5 Status Indication 0x0033 NPDI Universal ICB 0x0034 LAPD Frame 0x0035 LAPD Status 0x0065 TCAP Primitive
| Refer to Interworking TLVs if you have enabled interworking from the VoIP Protocol Configure 0x00EE message.
: | Checksum

Data

For SS7 MTP Message Tracing:

ICB Data Length n (variable)

Data [0] First byte of MSU Data

Data [n] End of MSU Data

NOTE: If ICB length is more than 200 bytes the following applies. For example: ICB Data Length is 450 bytes:

a. Then the first frame will be sent with the first 200 bytes of MSU Data with PPL Event Indication as
0x20: "SS7 MTP Message Tracing Not Last".

b. The second frame will be sent with the next 200 bytes of MSU Data with PPL Event Indication as
0x20: "MTP Message Tracing Not Last".

c. The third frame will be sent with the next 50 bytes of MSU Data with PPL Event Indication as
0x21: "MTP Message Tracing Last".

The length and content of the data varies according to the ICB subtype. A list of valid ICBs appears in the ICB chapter.

Response Status

If the MSB of the Status field is 0x50 (NACK), the LSB indicates the NACK reason.

0x01 Invalid module type for DPC/Stack/CICcombination.

Example: Host has sent a Service State Configure message with invalid DPC/Stack/CIC.

0x02 Message received for unassigned CIC.

Example: Host has sent a PPL Event Request for unassigned CIC.

0x03 Only Extended API is supported for VCIC.

See Programmable Protocol Language.
In PPL, a condition that, when met, drives a state machine (PPL Component) from one state to another, by invoking an associated Primitive. In PPL files, an Event is marked by an arrow and text.
See Information Control Block.
A condition that, when met, drives a state machine from one state to another. A condition that drives a Component out of its current state by invoking an associated primitive.
See Circuit Identification Codes.
See Address Information Block.
Session-Initiation Protocol. A signaling protocol used for establishing sessions in an IP network. A session could be a simple, two-way telephone call, or it could be a collaborative multi-media conference session.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
A programmable software component that uses PPL state machines that can be modified with the PPL Tool.
Most Significant Bit
Least Significant Bit
See Signaling System Number Seven.
See Message Transfer Part.
Negative acknowledgement to a message.
Destination Point Code
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.