com.refinitiv.eta.valueadd.cache

Interface PayloadCursor

public interface PayloadCursor

PayloadCursor is a utility class to allow retrieving encoded data in multiple parts from a cache payload entry. It is recommended for a cache reader to create a cursor and re-use it (using clear prior to the first retrieval of an entry). This will be more efficient than creating and destroying a cursor prior to each retrieval. The cursor can only be used on a single payload entry at a time, from first retrieval to last. If a cache reader needs to interleave retrieval calls across multiple entries, it should use a cursor for each payload entry.

See Also:

PayloadCache, PayloadEntry

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the state of the payload cursor.
void	destroy() Destroy the instance of the payload cursor.
boolean	isComplete() Returns the completion state of a multi-part payload entry retrieval.

Method Detail

destroy

void destroy()

Destroy the instance of the payload cursor. This is a thread safe method.

clear

void clear()

Clear the state of the payload cursor. This should be called prior to retrieving the first part from a payload entry.

isComplete

boolean isComplete()

Returns the completion state of a multi-part payload entry retrieval.

Returns:

Returns true after the last part has been retrieved from the entry.