You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > ARP Cache Query 0x00FC
SwitchKit Name
ARPCacheQuery
Type
EXS API and SwitchKit API message
Description:
Use this message to query or flush the entries in a module’s ARP cache.
If a query is sent, the Excel platform returns the data in an ARP Cache Report message. You can query a specific module by using the ARP query TLV.
If the amount of data returned exceeds the 512 byte maximum limit of a host message, the Excel platform sends multiple messages.
To remove entries, use the ARP Remove TLV. You can remove multiple entries by including multiple TLVs. The Excel platform returns a Status of Positive Acknowledgment (0x000A) upon removal.
NOTE: Entries are automatically flushed from the table if not accessed within five minutes after the connection is torn down.
Sent by:
SwitchKit Code
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE TLVDataType;
UBYTE TLVCount;
UBYTE TLVData[221];
} XL_ARPCacheQuery;
C++ Class
class XLC_ARPCacheQuery : public XLC_OutboundMessage {
public:
virtual int getTag() const;
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
// Extended addressing functions
// Slot AIB functions
UBYTE getSlot() const;
void setSlot(UBYTE x);
UBYTE getTLVDataType() const;
void setTLVDataType(UBYTE x);
UBYTE getTLVCount() const;
void setTLVCount(UBYTE 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 (0x0007) |
3, 4 |
Message Type (0x00FC) |
3, 4 |
Message Type (0x00FC) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
AIB Address Method 0x00 - Individual AEs |
8, 9 |
Response Status MSB, LSB 0x0002 Invalid Number of TLVs 0x0003 Invalid VoIP Module 0x0004 Invalid Number of Modules 0x0005 Invalid ARP Length 0x0006 Invalid ARP Cache TLV 0x0007 Entry Not Found in ARP Cache 0x0010 Positive ACK (Entry Flushed) |
Number of AEs to follow |
|||
AE |
|||
: |
Data Type (0x00: TLVs) |
10 |
Checksum |
: |
Number of TLVs to follow |
||
: |
Data (TLVs) |
||
: |
Checksum |