You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ARP Cache Report 0x00FB
SwitchKit Name
ARPCacheReport
Type
EXS API and SwitchKit API message
Description:
This message is sent by the Excel platform in response to an ARP Cache Query message. The report includes the IP address and Ethernet address for each entry queried. If the ARP cache size is larger than 512 bytes, multiple messages are sent.
SwitchKit Users
If you want to get this report, you must register for it by calling the sk_msgRegister function with the parameter, SK_ARP_CACHE_REPORT.
Sent by:
Excel platform
Resent in EXS API:
This message is resent once after five seconds.
SwitchKit Code
C Structure
typedef struct {
unsigned short Status;
UBYTE AddrInfo[30];
unsigned short TLVDataType;
unsigned short TLVCount;
UBYTE TLVData[217];
} XL_ARPCacheReport;
C++ Class
class XLC_ARPCacheReport : public XLC_InboundMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
// Extended addressing functions
// Slot AIB functions
UBYTE getSlot() const;;
void setSlot(UBYTE x);
// Module AIB functions
UBYTE getModule() const;
void setModule(UBYTE x);
unsigned short getTLVDataType() const;void setTLVDataType(unsigned short x);
unsigned short getTLVCount() const;
void setTLVCount(unsigned short x);
const UBYTE *getTLVData() const;
UBYTE *getTLVData();
void setTLVData(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 (0x0005) |
3, 4 |
Message Type (0x00FB) |
3, 4 |
Message Type (0x00FB) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8, 9 |
Always 0x10 (Positive ACK) |
8 |
Checksum |
: |
AIB Address Method 0x00 - Individual AEs |
|
|
Number of AEs to follow |
|||
AE |
|||
: |
Data Type: TLVs (0x00) |
||
: |
Total ARP Cache Entry Count |
||
: |
Number of TLVs to follow |
||
: |
Data (TLVs) |
||
: |
Checksum |