com.hazelcast.client.impl.protocol.template

Interface ResponseTemplate

public interface ResponseTemplate

Client Protocol Responses

Method Summary

Modifier and Type	Method and Description
void	AllScheduledTasksHandlers(List<Map.Entry<Member,List<ScheduledTaskHandler>>> handlers)
Object	Authentication(byte status, Address address, String uuid, String ownerUuid, byte serializationVersion, String serverHazelcastVersion, List<Member> clientUnregisteredMembers)
void	Boolean(boolean response)
void	CacheKeyIteratorResult(int tableIndex, List<Data> keys)
void	CRDTTimestampedLong(long value, List<Map.Entry<String,Long>> replicaTimestamps, int replicaCount) Long value with a vector clock which defines the updates that lead to the returned value.
void	Data(Data response)
void	EntriesWithCursor(int tableIndex, List<Map.Entry<Data,Data>> entries)
void	EntryView(SimpleEntryView<Data,Data> response, long maxIdle)
void	EventJournalInitialSubscriberState(long oldestSequence, long newestSequence)
void	Exception(int errorCode, String className, String message, StackTraceElement[] stacktrace, int causeErrorCode, String causeClassName)
void	IdBatch(long base, long increment, int batchSize)
void	Integer(int response)
Object	JobProcessInfo(List<JobPartitionState> jobPartitionStates, int processRecords)
void	ListData(List<Data> response)
void	ListDataMaybeNullElements(List<Data> response)
void	ListDistributedObject(List<DistributedObjectInfo> response)
void	ListEntry(List<Map.Entry<Data,Data>> response)
void	Long(long response)
void	NearCacheInvalidationMetaData(List<Map.Entry<String,List<Map.Entry<Integer,Long>>>> namePartitionSequenceList, List<Map.Entry<Integer,UUID>> partitionUuidList)
void	Partitions(List<Map.Entry<Address,List<Integer>>> partitions, int partitionStateVersion)
void	PartitionUuidList(List<Map.Entry<Integer,UUID>> partitionUuidList)
void	ReadResultSet(int readCount, List<Data> items, long[] itemSeqs, long nextSeq) A collection of items read from a data structure (e.g.
void	ResultSegment(List<Data> results, int nextTableIndexToReadFrom)
void	ScheduledTaskStatistics(long lastIdleTimeNanos, long totalIdleTimeNanos, long totalRuns, long totalRunTimeNanos, long lastRunDurationNanos)
void	String(String response)
void	Void()

Method Detail

Void

void Void()

Boolean

void Boolean(boolean response)

Parameters:

response - True if operation is successful, false otherwise.

Integer

void Integer(int response)

Parameters:

response - The operation result as an integer.

Long

void Long(long response)

Parameters:

response - The operation result as a long.

String

void String(String response)

Parameters:

response - The operation result as a string.

Data

void Data(@Nullable
          Data response)

Parameters:

response - The operation result as a serialized byte-array.

ListData

void ListData(List<Data> response)

Parameters:

response - The operation result as an array of serialized byte-array.

ListDataMaybeNullElements

void ListDataMaybeNullElements(@ContainsNullable
                               List<Data> response)

Parameters:

response - The operation result as an array of serialized byte-array that might have null entries.

ListEntry

void ListEntry(List<Map.Entry<Data,Data>> response)

Parameters:

response - The operation result as an array of serialized key-value byte-arrays.

Authentication

Object Authentication(byte status,
                      @Nullable
                      Address address,
                      @Nullable
                      String uuid,
                      @Nullable
                      String ownerUuid,
                      byte serializationVersion,
                      @Since(value="1.3")
                      String serverHazelcastVersion,
                      @Since(value="1.3") @Nullable
                      List<Member> clientUnregisteredMembers)

Parameters:

status - Authentication result as 0:AUTHENTICATED, 1:CREDENTIALS_FAILED, 2:SERIALIZATION_VERSION_MISMATCH

address - The address of the member server. This value will be null if status is not 0

uuid - Unique string identifying the connected client uniquely. This string is generated by the owner member server on initial connection. When the client connects to a non-owner member it sets this field on the request. This value will be null if status is not 0

ownerUuid - Unique string identifying the server member uniquely.This value will be null if status is not 0

serializationVersion - server side supported serialization version. This value should be used for setting serialization version if status is 2

serverHazelcastVersion - The hazelcast version of the member

clientUnregisteredMembers - The list of members at which the client has no resources. This may be due to the client no connected to the cluster at all or it may be that the cleanup operation is executed at the member and no resources of the particular client is left at the member. The client can use this information to restore its needed resources at the member, e.g. registers its listeners. The list will be empty if this is response to non-owner connection request.

Returns:

Returns the address, uuid and owner uuid.

Partitions

void Partitions(List<Map.Entry<Address,List<Integer>>> partitions,
                @Since(value="1.5")
                int partitionStateVersion)

Parameters:

partitions - mappings from member address to list of partition id 's that member owns

partitionStateVersion - strictly increasing version of the partitions table.

ListDistributedObject

void ListDistributedObject(List<DistributedObjectInfo> response)

Parameters:

response - An list of DistributedObjectInfo (service name and object name).

EntryView

void EntryView(@Nullable
               SimpleEntryView<Data,Data> response,
               @Since(value="1.7")
               long maxIdle)

Parameters:

response - Response as an EntryView Data type.

maxIdle - The maxIdle value of the entry

JobProcessInfo

Object JobProcessInfo(List<JobPartitionState> jobPartitionStates,
                      int processRecords)

Parameters:

jobPartitionStates - The state of the job. See Job Partition State Data Type description for details.

processRecords - Number of processed records.

Returns:

The information about the job if exists

CacheKeyIteratorResult

void CacheKeyIteratorResult(int tableIndex,
                            List<Data> keys)

Parameters:

tableIndex - the last tableIndex processed

keys - list of keys

Exception

void Exception(int errorCode,
               String className,
               @Nullable
               String message,
               StackTraceElement[] stacktrace,
               int causeErrorCode,
               @Nullable
               String causeClassName)

Parameters:

errorCode - error code of this exception

className - java class name of exception

message - details of exception

stacktrace - array of stack trace

causeErrorCode - error code of cause of this exception, if there is no cause -1

causeClassName - java class name of the cause of this exception

ReadResultSet

void ReadResultSet(int readCount,
                   List<Data> items,
                   @Since(value="1.5") @Nullable
                   long[] itemSeqs,
                   @Since(value="1.6")
                   long nextSeq)

A collection of items read from a data structure (e.g. ringbuffer), each identified with a sequence number (index).

Parameters:

readCount - The number of items read from the ringbuffer. This can be different from the size of the item array if a filter was applied when reading and some items were skipped and are not in the returned array. This can also be seen as the delta with which the user should increase his sequence counter after consuming all of the returned items in the result set to request the next set from the ringbuffer.

items - The array of serialized items.

itemSeqs - sequence IDs of returned ringbuffer items. This array can be null if the cluster version is 3.8 or lower. If the cluster version is 3.9 or higher then the array with sequence IDs will be sent. The array size is equal to the size of the items array and the arrays have a one-to-one mapping: the index of the sequence ID in the sequence array is equal to the index of the item in the item array. These sequences can be used to provide the user information to request a subset of the returned set if the user has for some reason stopped processing working when processing this returned set. If the ringbuffer is read without a filter then these sequences are a contiguous range and the size of the arrays is equal to the readCount.

nextSeq - the sequence of the item following the last read item. This sequence can then be used to read items following the ones returned by this result set. Usually this sequence is equal to the sequence used to retrieve this result set incremented by the readCount. In cases when the reader tolerates lost items, this is not the case. For instance, if the reader requests an item with a stale sequence (one which has already been overwritten), the read will jump to the oldest sequence and read from there. Similarly, if the reader requests an item in the future (e.g. because the partition was lost and the reader was unaware of this), the read method will jump back to the newest available sequence. Because of these jumps and only in the case when the reader is loss tolerant, this is the next sequence that must be used to read new items.

EntriesWithCursor

void EntriesWithCursor(int tableIndex,
                       List<Map.Entry<Data,Data>> entries)

Parameters:

tableIndex - the last tableIndex processed, it is used to act as a cursor to tell where should next batch read begin

entries - list of entries

ScheduledTaskStatistics

@Since(value="1.4")
void ScheduledTaskStatistics(long lastIdleTimeNanos,
                                                 long totalIdleTimeNanos,
                                                 long totalRuns,
                                                 long totalRunTimeNanos,
                                                 @Since(value="1.6")
                                                 long lastRunDurationNanos)

AllScheduledTasksHandlers

@Since(value="1.4")
void AllScheduledTasksHandlers(List<Map.Entry<Member,List<ScheduledTaskHandler>>> handlers)

NearCacheInvalidationMetaData

@Since(value="1.4")
void NearCacheInvalidationMetaData(List<Map.Entry<String,List<Map.Entry<Integer,Long>>>> namePartitionSequenceList,
                                                       List<Map.Entry<Integer,UUID>> partitionUuidList)

Parameters:

namePartitionSequenceList - name to partition sequenceId mapping list

partitionUuidList - partitionId to UUID mapping list

PartitionUuidList

@Since(value="1.4")
void PartitionUuidList(List<Map.Entry<Integer,UUID>> partitionUuidList)

Parameters:

partitionUuidList - partitionId to UUID mapping list

ResultSegment

@Since(value="1.5")
void ResultSegment(@ContainsNullable
                                       List<Data> results,
                                       int nextTableIndexToReadFrom)

Parameters:

results - The query results as an list of serialized projected entries that might have null entries

nextTableIndexToReadFrom - the index from which new items can be fetched

EventJournalInitialSubscriberState

@Since(value="1.5")
void EventJournalInitialSubscriberState(long oldestSequence,
                                                            long newestSequence)

Parameters:

oldestSequence - sequence ID of the oldest event in the event journal

newestSequence - sequence ID of the newest event in the event journal

IdBatch

@Since(value="1.6")
void IdBatch(long base,
                                 long increment,
                                 int batchSize)

CRDTTimestampedLong

@Since(value="1.6")
void CRDTTimestampedLong(long value,
                                             List<Map.Entry<String,Long>> replicaTimestamps,
                                             int replicaCount)

Long value with a vector clock which defines the updates that lead to the returned value.

Parameters:

value - the value

replicaTimestamps - the vector clock of the CRDT updates

replicaCount - the configured CRDT replica count