You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > PPL Event Request 0x0044
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
This message is sent to initiate a host event on a PPL component with optional ICB data.
NOTE: All PPL Event Indication messages that originate with the CIC PPL component will have the Virtual CIC AIB.
Sent by
Sample Message
In this sample, the host accepts a SIP registration request.
00 0B 00 44 00 00 FF 7F 00 A7 00 0A 00
SwitchKit Code
Configuration
PPLEventRequest (
Node = integer,
Span = integer,
Channel = integer,
Subrate = integer,
StackID = integer,
LinkID = integer,
Destination = integer,
Route = integer,
NumChannels = integer,
V5ID = integer,
TCAPStackID = integer,
SSN = integer,
ComponentID = integer,
PPLEvent = integer,
ICBCount = integer,
Data = byte array);
C Structure
typedef struct {
UBYTE AddrInfo[30];
unsigned short ComponentID;
unsigned short PPLEvent;
UBYTE ICBCount;
UBYTE Data[218];
} XL_PPLEventRequest;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE reserved6[13];
UBYTE Data[251];
} XL_PPLEventRequestAck;
C++ Class
class XLC_PPLEventRequest : public XLC_OutboundMessage {
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 getNumChannels() const;
void setNumChannels(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);
};
C++ Class Response
class XLC_PPLEventRequestAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(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 (0x00NN) |
1, 2 |
Length (0x0007) |
3, 4 |
Message Type (0x0044) |
3, 4 |
Message Type (0x0044) |
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. |
8, 9 |
If the value of the response’s Status field subsequent messages such as Connect or Release Channel. |
10 |
Checksum |
||
Number of AEs to follow |
|
|
|
AE The AE used depends on the component being addressed.
See PPL Component Addressing in the API Reference.
PPL Component ID (MSB, LSB). See PPL Component IDs in the API Reference. |
|||
: |
|||
: |
PPL Event (MSB, LSB) See PPL Information in the Developer’s Guides to find the PPL Events supported for each component. Developers Guide: Internet Protocol (IP) Developers Guide: Line Cards Developers Guide: Common Channel Signaling Developers Guide: Overview |
||
: |
Number of ICBs to follow (Ignore this field if no ICBs in message). |
||
: |
ICB Type 0x02 - Data 0x03 - Extended |
||
: |
ICB 0x02 Data ICBs |
||
|
The following TLVs are used to support the JT standard of Japanese 0x11 Signaling Route Test Control Status 0x12 Signaling Route Test Control DPC 0x03 Extended Data ICBs 0x0012 SS7 Formatted Parameters 0x0033 NPDI Universal ICB 0x0034 LAPD Frame 0x0065 SS7 TCAP Primitives |
||
|
Refer to Interworking TLVs if you have enabled interworking from the VoIP Protocol Configure 0x00EE message. |
||
: |
Checksum |