You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > System Resource Usage Query 0x008E

System Resource Usage Query 0x008E

SwitchKit Name

SystemResourceUtilQuery

Type

EXS API and SwitchKit API message

Description

System Resource Usage Query 0x008E

Use this message to query the utilization status of the following cards:

T-ONE, E-ONE, SS7 Series 3, SS7 PQ, DSP, and Matrix Controller.

Sent by

Host

Sample Message

In the following sample, the host sends the System Resource Usage Query to the CSP to query the Resource Usage for a Card. Following is the response from the CSP.

Host-to-CSP

 

00 10 00 8e 00 00 ff 02 00 01 01 01 09 04 00 01 02 03

 

CSP-to-Host Response

 

00 5f 00 8e 00 00 ff 00 10 02 00 01 01 01 09 04 00 26 03 01

02 00 02 48 c0 00 00 01 c0 03 00 02 63 00 00 00 00 00

05 00 05 9e 00 00 03 28 00 05 00 08 8c 00 00 00 06 00

01 01 00 02 08 00 00 01 a0 01 00 2d 19 03 1a 00 00 01

a0 07 00 2d 19 02 00 32 04 00 4b 05 00 4b 06 01 00 07

33 4b 32 03 00

SwitchKit Code

C Structure

typedef struct {

UBYTE QueryType;

UBYTE Slot;

UBYTE NumOfResources;

UBYTE Data[221];

} XL_SystemResourceUtilQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE QueryType;

UBYTE Data[250];

} XL_SystemResourceUtilQueryAck;

C++ Class

class XLC_SystemResourceUtilQuery : public XLC_OutboundMessage {

public:

UBYTE getQueryType() const;

void setQueryType(UBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getNumOfResources() const;

void setNumOfResources(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_SystemResourceUtilQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getQueryType() const;

void setQueryType(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 (0xNNNN)

1, 2

Length (0xNNNN)

3, 4

Message Type (0x008E)

3, 4

Message Type (0x008E)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Query Type

0x01 Conferencing Resources

0x02 Resource Usage for a Card

8, 9

Status MSB, LSB

NOTE: The following fields apply only if the Query Type field is 0x02

9

:

AIB

Address Method

0x00 - Individual AEs

Number of AEs to follow

AEs

0x01 Slot

:

Number of Resources

:

Resource ID 1

0x00 Memory
0x01 MCB
0x02 CPU Usage Level 1
0x03 CPU Usage Level 2

:

Checksum

10

Query Type

0x01 Conferencing Resources

0x02 Resource Usage for a Card

Note: The following fields apply only if the Query Type field is 0x02.

 

If the Query Type is 0x01 proceed to the Data below.

:

AIB

Address Method

0x00 - Individual AEs

:

Number of AEs to follow.

:

AEs

0x01 Slot

:

Number of Resurces

:

Data (continued below)

 

(For Query Type 0x01)

Data[0,1] Timeslots in use (MSB,LSB)

Data[2,3] Timeslots available (MSB,LSB)

Data[4,5] Percent used (0-100)

 

(For Query Type 0x02)

 

0x00 Resource ID: Memory

Data[0] Length

Data[1] Number of regions configured on the card

Data[2] Number of partitions configured on the card

Data[3] Region ID of Nth region

Data[4-7] Size of the region in bytes

Data[8-11] Number of bytes used from the region

Data [12] Partition ID of Nth partition

Data[13-16] Size of the partition in bytes

Data[17-20] Used bytes of partition

:

 

Data[:] Region ID of Nth region(1 byte)
Data[:] Size of the Nth region in bytes (4 bytes)
Data[:] Number of bytes used from the Nth region(4 bytes)
Data [:] Partition ID of 1st partition (1 byte)
Data[:] Size of the 1st partition in bytes (4 bytes)
Data[:] Used bytes of 1st partition (4 bytes)
:
Data [:] Partition ID of Nth partition (1 byte)
Data[:] Size of the Nth partition in bytes (4 bytes)
Data[:] Used bytes of Nth partition (4 bytes)

 

 

Repeat for each region

Data[n] Region ID of Nth region

Data[n+1 - n+4] Size of the region in bytes

Data[n+5 - n+8] Number of bytes used from the region

 

Repeat for each segment

Data[n] Partition ID of Nth partition

Data[n+1 - n+4] Size of the partition in bytes

Data[n+5 - n+8] Number of bytes used from the partition

 

0x01 Resource ID: MCB

Data[0] Length

Data[1] Message buffer usage

 

0x02 Resource ID: CPU Usage Level 1

Data[0] Length

Data[1-4] Time in milliseconds covering this report

Data[5] Number of tasks reported (0x01)

Data[6] Logical task ID (idle task only 0x00)

Data[7] Percentage of time usage for task (integer part)

Data[8] Percentage of time usage for task (decimal part)

 

0x03 Resource ID: CPU Usage Level 2

Data[0] Length

Data[1-4] Time in milliseconds covering this report

Data[5] Number of tasks reported (the following repeats for each task)

Data[6] Logical task ID

Data[7] Percentage of time usage for task (integer part)

Data[8] Percentage of time usage for task (decimal part)

 

0x04 Resource ID: CPU Usage Level 3

Data[0] Length

Data[1-4] Time in milliseconds covering this report

Data[5] Number of tasks reported (the following repeats for each task)

Data[6-9] Task Name (ASCII)

Data[10] Percentage of time usage for task (integer part)

Data[11] Percentage of time usage for task (decimal part)

15

Checksum