You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Statistics Query 0x0121

Statistics Query 0x0121

SwitchKit Name

Statistics Query

Type

EXS API and SwitchKit API message

Description

Statistics Query 0x0121

NOTE: This message applies to the DSP Series 2 card only.

Use this message to query cache and function usage statistics that are kept on the DSP Series 2 card. The statistics are stored in cache for 16 days, and then they are replaced one-by-one with more recent statistics. At any time, you can view statistics for the past 16 days. You can configure the time to copy statistics into the buffer from one second to 86,400 seconds, in one-second increments.

This message does not support wildcards for the DSP Chip AIB, because the data that comes back from the CSP would be too long.

Sent by

Host Application

SwitchKit Code

C Structure

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE TLVCount;

UBYTE Data[250];

} XL_StatisticsQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved[13];

UBYTE AddrInfo[251];

UBYTE TLVCount;

UBYTE Data[250];

} XL_StatisticsQueryAck;

C++ Class

class XLC_StatisticsQuery : public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

// Extended addressing functions

// DSP Chip AIB functions

void DSPChip(UBYTE x);

UBYTE getDSPSlot() const;

void setDSPSlot(UBYTE x);

UBYTE getDSPSIMM() const;

void setDSPSIMM(UBYTE x);

// Slot AIB functions

UBYTE getSlot() const ;

void setSlot(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x)

};

C++ Class Response

class XLC_StatisticsQueryAck : public XLC_OutboundMessage {

public:

unsigned short getStatus() const

void setStatus(unsigned short x)

UBYTE getTLVCount() const;

void setTLVCount(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 (0x00NN)
3, 4 | Message Type (0x0121) | 3, 4 | Message Type (0x0121)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB) 0x0001 - Invalid TLV Data Software can't find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0003 - Invalid number of TLVs. 0x0004 - Invalid TLV Length 0x0006 - Invalid TLV 0x000D - Mandatory TLVs missing Also see Common Response Status Values
Number of AEs to follow | 10 | Number of TLVs to Follow
AE 0x01 Slot (to query a DSP 2 card, or a CSP Matrix Series 3 Card for a system query) 0x01 Slot and 0x22 DSP Chip (to query an individual DSP chip) NOTE: You can also do a system query by sending a Null AIB: Address Method = 0x00 Number of AEs = 0x00 No AE Data | : | TLVs The first TLV returned is the same Query Statistics TLV sent down by the host, indicating the object queried. 0x05F9 Query Statistics Additional TLVs returned depend on the entity queried. Query Type: 0x0400 - DSP Function Statistics 0x05F7 DSP Function Statistics Query Type: 0x0401 - NFS Statistics 0x05F8 NFS Statistics Query Type: 0x0402 - Fixed Memory Statistics 0x05F5 Fixed Memory Statistics Query Type: 0x0403 - DSP Series 2 Cache Statistics 0x05F6 DSP Series 2 Cache Statistics Query Type: 0x0404) - Resource Point Statistics 0x05FE Resource Point Statistics Query Type: 0x0405) - CPU Statistics 0x05FD CPU Statistics Query Type: 0x0406) - DSP 2 Overload Statistics 0x0616 DSP Series 2 Overload Statistics
: | Data Type 0x00 TLVs | : | Checksum
: | Number of TLVs to Follow |  |
: | TLV 0x05F9 Query Statistics Query Types 0x0400 - DSP Function Statistics 0x0401 - NFS Statistics 0x0402 - Fixed Memory Statistics 0x0403 - DSP Series 2 Cache Statistics 0x0404 - Resource Point Statistics* 0x0405 - CPU Statistics 0x0406 - DSP 2 Overload Statistics 0xFFFF - All valid queries for the Slot or SIMM
: | Checksum

* TLV 0x05F9, query type 0404 is only valid while addressing the CSP Matrix Series 3 Card slot to query Resource Points. It does not work, if you address the DSP Series 2 card slot to query Resource Points.

Digital Signal Processor
See Address Information Block.
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.
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.
Most Significant Bit
Least Significant Bit
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.