com.refinitiv.eta.valueadd.cache

Interface PayloadCache

public interface PayloadCache

PayloadCache is a collection of PayloadEntry instances that use the same DataDictionary.

See Also:

PayloadEntry, CacheError

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the cache by destroying all payload entries.
void	destroy() Destroy the instance of the cache container.
void	destroyAll() Destroy all cache instances.
int	entryCount() Returns the number of payload entries contained in this cache.
java.util.List<PayloadEntry>	entryList() Returns a list of payload entries contained in this cache.
int	setDictionary(com.refinitiv.eta.codec.DataDictionary fidDictionary, java.lang.String dictionaryKey, CacheError error) Sets the RDM Field Dictionary using the given dictionaryKey name An RDM Field Dictionary (type RWFFld) is required for each cache.
int	setSharedDictionaryKey(java.lang.String dictionaryKey, CacheError error) Sets a dictionary to this cache that was previously bound to another cache.

Method Detail

setDictionary

int setDictionary(com.refinitiv.eta.codec.DataDictionary fidDictionary,
                  java.lang.String dictionaryKey,
                  CacheError error)

Sets the RDM Field Dictionary using the given dictionaryKey name An RDM Field Dictionary (type RWFFld) is required for each cache. To share a dictionary with more than one cache, use setSharedDictionaryKey with the same dictionaryKey after using this function for the initial setting. If this function is called a second time with the same dictionaryKey, it is handled as a dictionary extension. If the contents of the fidDictionary are a valid extension of the fidDictionary previously bound by this key, then these additions will be added to the field database in the cache for this key. Valid extensions to a dictionary are field additions; changes or deletions to the field list will cause the extension setting to fail. The enum dictionary is not used by the cache, and is not required to be loaded in the fidDictionary structure.

Parameters:

fidDictionary - The dictionary structure containing a decoded RDM Field Dictionary

dictionaryKey - A string token naming the dictionary being bound to the cache

error - Error information structure populated if the cache set fails

Returns:

Will return a failure code if the fidDictionary cannot be set to the cache.

setSharedDictionaryKey

int setSharedDictionaryKey(java.lang.String dictionaryKey,
                           CacheError error)

Sets a dictionary to this cache that was previously bound to another cache. This function enables sharing a dictionary between more than one cache.

Parameters:

dictionaryKey - A string token naming the dictionary being set to the cache

error - Error information structure populated if the set fails

Returns:

Will return a failure code if this dictionaryKey is not known (from a previous bind using the bindDictionary function).

entryCount

int entryCount()

Returns the number of payload entries contained in this cache.

Returns:

The number of entries in this cache instance

entryList

java.util.List<PayloadEntry> entryList()

Returns a list of payload entries contained in this cache.

Returns:

The list of entries in this cache instance

destroy

void destroy()

Destroy the instance of the cache container. This is a thread safe method

clear

void clear()

Clears the cache by destroying all payload entries.

destroyAll

void destroyAll()

Destroy all cache instances. This is a thread safe method.
- invalidates all caches, entries and cursors;
- application is responsible for removing references to all caches, entries and cursors;