DSP Cache Modify 0x011A

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > DSP Cache Modify 0x011A

SwitchKit Name

DSPCacheModify

Type

EXS API and SwitchKit API message

Description

DSP Cache Modify 0x011A

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

Use this message to clear either a single file ID (including a file ID for a temporary recording) or all file IDs on the main board cache as well as the cache on all the DSPs. You can also use this message to copy any file residing in cache (playback or recording) to permanent storage on a server.

Sent by

Host Application

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE reserved18[29];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[220];

} XL_DSPCacheModify;

C++ Class

class XLC_DSPCacheModify : public XLC_OutboundMessage {

public:

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);

};

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 (0x011A)	3, 4	Message Type (0x011A)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Same Sequence Number
7	Logical Node ID	7	Logical Node ID
:	AIB Address Method 0x00 - Individual AEs	8, 9	Status (MSB, LSB) 0x0001 Invalid TLV Data – Possible reasons for this Nack are as follows: - File ID is not cached. - File cannot be written to the NFS server. This could be due to multiple reasons. - File not present in cache - NFS server not mounted - NFS server is mounted but the file could not be - opened/written (for example, if the share does not - have write permission or the server runs out of space) 0x0003 Invalid number of TLVs There are no TLVs in the message. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV. 0x000D Mandatory TLVs missing One or more mandatory TLVs is missing. Also see Common Response Status Values in the API Reference
	AIB Address Method 0x00 - Individual AEs	10	Checksum
	Number of AEs to follow
	AE 0x01 Slot
:	Data Type 0x00 TLVs
:	Number of TLVs to Follow
:	TLVs 0x05FA Card Object 0x05FF DSP Cache Modify Action If the DSP Cache Modify Action TLV specifies Clear Specific Cache (0x0000), then one or more File ID TLVs (0x05E0) are required. If the DSP Cache Modify Action TLV specifies Copy Specific Cache (0x0002), then the File ID (0x05E0), File Format (0x05E1) and File Location (0x05E2) TLVs are required If the DSP Cache Modify Action TLV specifies Clear All (0x0001), then no other TLVs are required besides 0x05FA Card Object 0x05E0 File ID 0x05E1 File Format 0x05E2 File Location
:	Checksum