Protocol Messages

Compound Data Types Used In The Protocol Specification

Some common compound data structures used in the protocol message specification are defined in this section.

Array

In the protocol specification, an array of a data type is frequently used. An array of a data type with n entries is encoded as shown below:

Address Data Type

Cache Event Data Type

Distributed Object Info Data Type

Entry View Data Type

Job Partition State Data Type

Member Data Type

n is the number of attributes for the server member.

Query Cache Event Data Type

Transaction Id Data Type

Stack Trace Data type

Error Message

Response Message Type Id: 109

The following error codes are defined in the system:

General Protocol Operations (No Specific Object)

"Authentication" Operation

Request Message Type Id:0x2, Retryable:Yes

Response Message Type Id:107

Returns the address, uuid and owner uuid.

"AuthenticationCustom" Operation

Request Message Type Id:0x3, Retryable:Yes

Response Message Type Id:107

Returns the address, uuid and owner uuid.

"MembershipListener" Operation

Request Message Type Id:0x4, Retryable:No

Header only request message, no message body exist.

Response Message Type Id:104

Returns the registration id for the listener.

"Member" Event Message

Message Type Id:200

"MemberSet" Event Message

Message Type Id:201

"MemberAttributeChange" Event Message

Message Type Id:202

"CreateProxy" Operation

Request Message Type Id:0x5, Retryable:No

Response Message Type Id:100

Header only response message, no message body exist.

"DestroyProxy" Operation

Request Message Type Id:0x6, Retryable:No

Response Message Type Id:100

Header only response message, no message body exist.

"GetPartitions" Operation

Request Message Type Id:0x8, Retryable:No

Header only request message, no message body exist.

Response Message Type Id:108

The partition list for each member address.

"RemoveAllListeners" Operation

Request Message Type Id:0x9, Retryable:No

Header only request message, no message body exist.

Response Message Type Id:100

Header only response message, no message body exist.

"AddPartitionLostListener" Operation

Request Message Type Id:0xa, Retryable:Yes

Header only request message, no message body exist.

Response Message Type Id:104

The listener registration id.

"PartitionLost" Event Message

Message Type Id:206

"RemovePartitionLostListener" Operation

Request Message Type Id:0xb, Retryable:No

Response Message Type Id:101

true if the listener existed and removed, false otherwise.

"GetDistributedObjects" Operation

Request Message Type Id:0xc, Retryable:No

Header only request message, no message body exist.

Response Message Type Id:110

An array of distributed object info in the cluster.

"AddDistributedObjectListener" Operation

Request Message Type Id:0xd, Retryable:Yes

Header only request message, no message body exist.

Response Message Type Id:104

The registration id for the distributed object listener.

"DistributedObject" Event Message

Message Type Id:207

"RemoveDistributedObjectListener" Operation

Request Message Type Id:0xe, Retryable:No

Response Message Type Id:101

true if the listener existed and removed, false otherwise.

"Ping" Operation

Request Message Type Id:0xf, Retryable:Yes

Header only request message, no message body exist.

Response Message Type Id:100

Header only response message, no message body exist.

Map Object

"Put" Operation

Request Message Type Id:0x0101, Retryable:No

Puts an entry into this map with a given ttl (time to live) value.Entry will expire and get evicted after the ttl
If ttl is 0, then the entry lives forever.This method returns a clone of the previous value, not the original
(identically equal) value previously put into the map.Time resolution for TTL is seconds. The given TTL value is
rounded to the next closest second value.

Response Message Type Id:105

old value of the entry

"Get" Operation

Request Message Type Id:0x0102, Retryable:Yes

This method returns a clone of the original value, so modifying the returned value does not change the actual
value in the map. You should put the modified value back to make changes visible to all nodes.

Response Message Type Id:105

The value for the key if exists

"Remove" Operation

Request Message Type Id:0x0103, Retryable:No

Removes the mapping for a key from this map if it is present (optional operation).
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also
possible that the map explicitly mapped the key to null. The map will not contain a mapping for the specified key once the
call returns.

Response Message Type Id:105

Clone of the removed value, not the original (identically equal) value previously put into the map.

"Replace" Operation

Request Message Type Id:0x0104, Retryable:No

Replaces the entry for a key only if currently mapped to a given value.

Response Message Type Id:105

Clone of the previous value, not the original (identically equal) value previously put into the map.

"ReplaceIfSame" Operation

Request Message Type Id:0x0105, Retryable:No

Replaces the the entry for a key only if existing values equal to the testValue

Response Message Type Id:101

true if value is replaced with new one, false otherwise

"PutAsync" Operation

Request Message Type Id:0x0106, Retryable:No

Asynchronously puts the given key and value into this map with a given ttl (time to live) value.Entry will expire
and get evicted after the ttl. If ttl is 0, then the entry lives forever. Time resolution for TTL is seconds.
The given TTL value is rounded to the next closest second value.

Response Message Type Id:105

Clone of the previous value, not the original (identically equal) value previously put into the map.

"GetAsync" Operation

Request Message Type Id:0x0107, Retryable:Yes

Asynchronously gets the given key.

Response Message Type Id:105

Clone of the value if exists, not the original (identically equal) value previously put into the map.

"RemoveAsync" Operation

Request Message Type Id:0x0108, Retryable:No

Asynchronously removes the given key.

Response Message Type Id:105

Clone of the removed value, not the original (identically equal) value previously put into the map.

"ContainsKey" Operation

Request Message Type Id:0x0109, Retryable:Yes

Returns true if this map contains a mapping for the specified key.

Response Message Type Id:101

Returns true if the key exists, otherwise returns false.

"ContainsValue" Operation

Request Message Type Id:0x010a, Retryable:Yes

Returns true if this map maps one or more keys to the specified value.This operation will probably require time
linear in the map size for most implementations of the Map interface.

Response Message Type Id:101

Returns true if the value exists, otherwise returns false.

"RemoveIfSame" Operation

Request Message Type Id:0x010b, Retryable:No

Removes the mapping for a key from this map if existing value equal to the this value

Response Message Type Id:101

Returns true if the key exists and removed, otherwise returns false.

"Delete" Operation

Request Message Type Id:0x010c, Retryable:No

Removes the mapping for a key from this map if it is present.Unlike remove(Object), this operation does not return
the removed value, which avoids the serialization cost of the returned value.If the removed value will not be used,
a delete operation is preferred over a remove operation for better performance. The map will not contain a mapping
for the specified key once the call returns.
This method breaks the contract of EntryListener. When an entry is removed by delete(), it fires an EntryEvent
with a null oldValue. Also, a listener with predicates will have null values, so only keys can be queried via predicates

Response Message Type Id:100

Header only response message, no message body exist.

"Flush" Operation

Request Message Type Id:0x010d, Retryable:No

If this map has a MapStore, this method flushes all the local dirty entries by calling MapStore.storeAll()
and/or MapStore.deleteAll().

Response Message Type Id:100

Header only response message, no message body exist.

"TryRemove" Operation

Request Message Type Id:0x010e, Retryable:No

Tries to remove the entry with the given key from this map within the specified timeout value.
If the key is already locked by another thread and/or member, then this operation will wait the timeout
amount for acquiring the lock.

Response Message Type Id:101

Returns true if successful, otherwise returns false

"TryPut" Operation

Request Message Type Id:0x010f, Retryable:No

Tries to put the given key and value into this map within a specified timeout value. If this method returns false,
it means that the caller thread could not acquire the lock for the key within the timeout duration,
thus the put operation is not successful.

Response Message Type Id:101

Returns true if successful, otherwise returns false

"PutTransient" Operation

Request Message Type Id:0x0110, Retryable:No

Same as put except that MapStore, if defined, will not be called to store/persist the entry.
If ttl is 0, then the entry lives forever.

Response Message Type Id:100

Header only response message, no message body exist.

"PutIfAbsent" Operation

Request Message Type Id:0x0111, Retryable:No

Puts an entry into this map with a given ttl (time to live) value if the specified key is not already associated
with a value. Entry will expire and get evicted after the ttl.

Response Message Type Id:105

returns a clone of the previous value, not the original (identically equal) value previously put into the map.

"Set" Operation

Request Message Type Id:0x0112, Retryable:No

Puts an entry into this map with a given ttl (time to live) value.Entry will expire and get evicted after the ttl
If ttl is 0, then the entry lives forever. Similar to the put operation except that set doesn't
return the old value, which is more efficient.

Response Message Type Id:100

Header only response message, no message body exist.

"Lock" Operation

Request Message Type Id:0x0113, Retryable:No

Acquires the lock for the specified lease time.After lease time, lock will be released.If the lock is not
available then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock
has been acquired.
Scope of the lock is this map only. Acquired lock is only for the key in this map. Locks are re-entrant,
so if the key is locked N times then it should be unlocked N times before another thread can acquire it.

Response Message Type Id:100

Header only response message, no message body exist.

"TryLock" Operation

Request Message Type Id:0x0114, Retryable:No

Tries to acquire the lock for the specified key for the specified lease time.After lease time, the lock will be
released.If the lock is not available, then the current thread becomes disabled for thread scheduling
purposes and lies dormant until one of two things happens the lock is acquired by the current thread, or
the specified waiting time elapses.

Response Message Type Id:101

Returns true if successful, otherwise returns false

"IsLocked" Operation

Request Message Type Id:0x0115, Retryable:Yes

Checks the lock for the specified key.If the lock is acquired then returns true, else returns false.

Response Message Type Id:101

Returns true if the entry is locked, otherwise returns false

"Unlock" Operation

Request Message Type Id:0x0116, Retryable:No

Releases the lock for the specified key. It never blocks and returns immediately.
If the current thread is the holder of this lock, then the hold count is decremented.If the hold count is zero,
then the lock is released. If the current thread is not the holder of this lock,
then ILLEGAL_MONITOR_STATE is thrown.

Response Message Type Id:100

Header only response message, no message body exist.

"AddInterceptor" Operation

Request Message Type Id:0x0117, Retryable:No

Adds an interceptor for this map. Added interceptor will intercept operations
and execute user defined methods and will cancel operations if user defined method throw exception.

Response Message Type Id:104

id of registered interceptor.

"RemoveInterceptor" Operation

Request Message Type Id:0x0118, Retryable:No

Removes the given interceptor for this map so it will not intercept operations anymore.

Response Message Type Id:101

Returns true if successful, otherwise returns false

"AddEntryListenerToKeyWithPredicate" Operation

Request Message Type Id:0x0119, Retryable:Yes

Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener
sub-interface for that event.

Response Message Type Id:104

A unique string which is used as a key to remove the listener.

"Entry" Event Message

Message Type Id:203

"AddEntryListenerWithPredicate" Operation

Request Message Type Id:0x011a, Retryable:Yes

Adds an continuous entry listener for this map. Listener will get notified for map add/remove/update/evict events
filtered by the given predicate.

Response Message Type Id:104

A unique string which is used as a key to remove the listener.

"Entry" Event Message

Message Type Id:203

"AddEntryListenerToKey" Operation

Request Message Type Id:0x011b, Retryable:Yes

Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener
sub-interface for that event.

Response Message Type Id:104

A unique string which is used as a key to remove the listener.

"Entry" Event Message

Message Type Id:203

"AddEntryListener" Operation

Request Message Type Id:0x011c, Retryable:Yes

Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener
sub-interface for that event.

Response Message Type Id:104

A unique string which is used as a key to remove the listener.

"Entry" Event Message

Message Type Id:203

"AddNearCacheEntryListener" Operation

Request Message Type Id:0x011d, Retryable:Yes

Adds an entry listener for this map. Listener will get notified for all map add/remove/update/evict events.

Response Message Type Id:104

A unique string which is used as a key to remove the listener.

"Entry" Event Message

Message Type Id:203

"RemoveEntryListener" Operation

Request Message Type Id:0x011e, Retryable:No

Removes the specified entry listener. Returns silently if there is no such listener added before.

Response Message Type Id:101

true if registration is removed, false otherwise.

"AddPartitionLostListener" Operation

Request Message Type Id:0x011f, Retryable:Yes

Adds a MapPartitionLostListener. The addPartitionLostListener returns a register-id. This id is needed to remove
the MapPartitionLostListener using the removePartitionLostListener(String) method.
There is no check for duplicate registrations, so if you register the listener twice, it will get events twice.
IMPORTANT: Please see com.hazelcast.partition.PartitionLostListener for weaknesses.
IMPORTANT: Listeners registered from HazelcastClient may miss some of the map partition lost events due
to design limitations.

Response Message Type Id:104

returns the registration id for the MapPartitionLostListener.

"MapPartitionLost" Event Message

Message Type Id:209

"RemovePartitionLostListener" Operation

Request Message Type Id:0x0120, Retryable:No

Removes the specified map partition lost listener. Returns silently if there is no such listener added before.

Response Message Type Id:101

true if registration is removed, false otherwise.

"GetEntryView" Operation

Request Message Type Id:0x0121, Retryable:Yes

Returns the EntryView for the specified key.
This method returns a clone of original mapping, modifying the returned value does not change the actual value
in the map. One should put modified value back to make changes visible to all nodes.

Response Message Type Id:111

EntryView of the specified key.

"Evict" Operation

Request Message Type Id:0x0122, Retryable:No

Evicts the specified key from this map. If a MapStore is defined for this map, then the entry is not deleted
from the underlying MapStore, evict only removes the entry from the memory.

Response Message Type Id:101

true if the key is evicted, false otherwise.

"EvictAll" Operation

Request Message Type Id:0x0123, Retryable:No

Evicts all keys from this map except the locked ones. If a MapStore is defined for this map, deleteAll is not
called by this method. If you do want to deleteAll to be called use the clear method. The EVICT_ALL event is
fired for any registered listeners.

Response Message Type Id:100

Header only response message, no message body exist.

"LoadAll" Operation

Request Message Type Id:0x0124, Retryable:No

Loads all keys into the store. This is a batch load operation so that an implementation can optimize the multiple loads.

Response Message Type Id:100

Header only response message, no message body exist.

"LoadGivenKeys" Operation

Request Message Type Id:0x0125, Retryable:No

Loads the given keys. This is a batch load operation so that an implementation can optimize the multiple loads.

Response Message Type Id:100

Header only response message, no message body exist.

"KeySet" Operation

Request Message Type Id:0x0126, Retryable:No

Returns a set clone of the keys contained in this map. The set is NOT backed by the map, so changes to the map
are NOT reflected in the set, and vice-versa. On the server side this method is executed by a distributed query
so it may throw a QUERY_RESULT_SIZE_EXCEEDED if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:113

a set clone of the keys contained in this map.

"GetAll" Operation

Request Message Type Id:0x0127, Retryable:No

Returns the entries for the given keys. If any keys are not present in the Map, it will call loadAll The returned
map is NOT backed by the original map, so changes to the original map are NOT reflected in the returned map, and vice-versa.

Response Message Type Id:114

values for the provided keys.

"Values" Operation

Request Message Type Id:0x0128, Retryable:No

Returns a collection clone of the values contained in this map.
The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.
On the server side this method is executed by a distributed query so it may throw a QUERY_RESULT_SIZE_EXCEEDED
if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:106

All values in the map

"EntrySet" Operation

Request Message Type Id:0x0129, Retryable:No

Returns a Set clone of the mappings contained in this map.
The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.
On the server side this method is executed by a distributed query so it may throw a QueryResultSizeExceededException
if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:114

a set clone of the keys mappings in this map

"KeySetWithPredicate" Operation

Request Message Type Id:0x012a, Retryable:No

Queries the map based on the specified predicate and returns the keys of matching entries. Specified predicate
runs on all members in parallel.The set is NOT backed by the map, so changes to the map are NOT reflected in the
set, and vice-versa This method is always executed by a distributed query so it may throw a
QUERY_RESULT_SIZE_EXCEEDED if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:113

result key set for the query.

"ValuesWithPredicate" Operation

Request Message Type Id:0x012b, Retryable:No

Queries the map based on the specified predicate and returns the values of matching entries.Specified predicate
runs on all members in parallel.The collection is NOT backed by the map, so changes to the map are NOT reflected
in the collection, and vice-versa.This method is always executed by a distributed query so it may throw a
QUERY_RESULT_SIZE_EXCEEDED if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:106

result value collection of the query.

"EntriesWithPredicate" Operation

Request Message Type Id:0x012c, Retryable:No

Queries the map based on the specified predicate and returns the matching entries.Specified predicate
runs on all members in parallel.The collection is NOT backed by the map, so changes to the map are NOT reflected
in the collection, and vice-versa.This method is always executed by a distributed query so it may throw a
QUERY_RESULT_SIZE_EXCEEDED if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:114

result key-value entry collection of the query.

"AddIndex" Operation

Request Message Type Id:0x012d, Retryable:No

Adds an index to this map for the specified entries so that queries can run faster.If you are querying your values
mostly based on age and active then you should consider indexing these fields.
Index attribute should either have a getter method or be public.You should also make sure to add the indexes before
adding entries to this map.
Indexing time is executed in parallel on each partition by operation threads. The Map is not blocked during this
operation.The time taken in proportional to the size of the Map and the number Members.
Until the index finishes being created, any searches for the attribute will use a full Map scan, thus avoiding
using a partially built index and returning incorrect results.

Response Message Type Id:100

Header only response message, no message body exist.

"Size" Operation

Request Message Type Id:0x012e, Retryable:Yes

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements,
returns Integer.MAX_VALUE

Response Message Type Id:102

the number of key-value mappings in this map

"IsEmpty" Operation

Request Message Type Id:0x012f, Retryable:Yes

Returns true if this map contains no key-value mappings.

Response Message Type Id:101

true if this map contains no key-value mappings

"PutAll" Operation

Request Message Type Id:0x0130, Retryable:No

Copies all of the mappings from the specified map to this map (optional operation).The effect of this call is
equivalent to that of calling put(Object,Object) put(k, v) on this map once for each mapping from key k to value
v in the specified map.The behavior of this operation is undefined if the specified map is modified while the
operation is in progress.

Response Message Type Id:100

Header only response message, no message body exist.

"Clear" Operation

Request Message Type Id:0x0131, Retryable:No

This method clears the map and invokes MapStore#deleteAll deleteAll on MapStore which, if connected to a database,
will delete the records from that database. The MAP_CLEARED event is fired for any registered listeners.
To clear a map without calling MapStore#deleteAll, use #evictAll.

Response Message Type Id:100

Header only response message, no message body exist.

"ExecuteOnKey" Operation

Request Message Type Id:0x0132, Retryable:No

Applies the user defined EntryProcessor to the entry mapped by the key. Returns the the object which is result of
the process() method of EntryProcessor.

Response Message Type Id:105

result of entry process.

"SubmitToKey" Operation

Request Message Type Id:0x0133, Retryable:No

Applies the user defined EntryProcessor to the entry mapped by the key. Returns immediately with a Future
representing that task.EntryProcessor is not cancellable, so calling Future.cancel() method won't cancel the
operation of EntryProcessor.

Response Message Type Id:105

result of entry process.

"ExecuteOnAllKeys" Operation

Request Message Type Id:0x0134, Retryable:No

Applies the user defined EntryProcessor to the all entries in the map.Returns the results mapped by each key in the map.

Response Message Type Id:114

results of entry process on the entries

"ExecuteWithPredicate" Operation

Request Message Type Id:0x0135, Retryable:No

Applies the user defined EntryProcessor to the entries in the map which satisfies provided predicate.
Returns the results mapped by each key in the map.

Response Message Type Id:114

results of entry process on the entries matching the query criteria

"ExecuteOnKeys" Operation

Request Message Type Id:0x0136, Retryable:No

Applies the user defined EntryProcessor to the entries mapped by the collection of keys.The results mapped by
each key in the collection.

Response Message Type Id:114

results of entry process on the entries with the provided keys

"ForceUnlock" Operation

Request Message Type Id:0x0137, Retryable:No

Releases the lock for the specified key regardless of the lock owner.It always successfully unlocks the key,
never blocks,and returns immediately.

Response Message Type Id:100

Header only response message, no message body exist.

"KeySetWithPagingPredicate" Operation

Request Message Type Id:0x0138, Retryable:No

Response Message Type Id:113

result keys for the query.

"ValuesWithPagingPredicate" Operation

Request Message Type Id:0x0139, Retryable:No

Queries the map based on the specified predicate and returns the values of matching entries. Specified predicate
runs on all members in parallel. The collection is NOT backed by the map, so changes to the map are NOT reflected
in the collection, and vice-versa. This method is always executed by a distributed query so it may throw a
QUERY_RESULT_SIZE_EXCEEDED if GroupProperties#PROP_QUERY_RESULT_SIZE_LIMIT is configured.

Response Message Type Id:114

values for the query.

"EntriesWithPagingPredicate" Operation

Request Message Type Id:0x013a, Retryable:No

Response Message Type Id:114

key-value pairs for the query.

MultiMap Object

"Put" Operation

Request Message Type Id:0x0201, Retryable:No

Stores a key-value pair in the multimap.

Response Message Type Id:101

True if size of the multimap is increased, false if the multimap already contains the key-value pair.

"Get" Operation

Request Message Type Id:0x0202, Retryable:Yes

Returns the collection of values associated with the key. The collection is NOT backed by the map, so changes to
the map are NOT reflected in the collection, and vice-versa.

Response Message Type Id:106

The collection of the values associated with the key.

"Remove" Operation

Request Message Type Id:0x0203, Retryable:No

Removes the given key value pair from the multimap.

Response Message Type Id:106

True if the size of the multimap changed after the remove operation, false otherwise.

"KeySet" Operation

Request Message Type Id:0x0204, Retryable:Yes

Returns the set of keys in the multimap.The collection is NOT backed by the map, so changes to the map are NOT
reflected in the collection, and vice-versa.

Response Message Type Id:113

The set of keys in the multimap. The returned set might be modifiable but it has no effect on the multimap.

"Values" Operation

Request Message Type Id:0x0205, Retryable:Yes

Returns the collection of values in the multimap.The collection is NOT backed by the map, so changes to the map
are NOT reflected in the collection, and vice-versa.

Response Message Type Id:106

The collection of values in the multimap. the returned collection might be modifiable but it has no effect on the multimap.

"EntrySet" Operation

Request Message Type Id:0x0206, Retryable:Yes

Returns the set of key-value pairs in the multimap.The collection is NOT backed by the map, so changes to the map
are NOT reflected in the collection, and vice-versa

Response Message Type Id:114

The set of key-value pairs in the multimap. The returned set might be modifiable but it has no effect on the multimap.

"ContainsKey" Operation

Request Message Type Id:0x0207, Retryable:Yes

Returns whether the multimap contains an entry with the key.

Response Message Type Id:101

True if the multimap contains an entry with the key, false otherwise.

"ContainsValue" Operation

Request Message Type Id:0x0208, Retryable:Yes

Returns whether the multimap contains an entry with the value.

Response Message Type Id:101

True if the multimap contains an entry with the value, false otherwise.

"ContainsEntry" Operation

Request Message Type Id:0x0209, Retryable:Yes

Returns whether the multimap contains the given key-value pair.

Response Message Type Id:101

True if the multimap contains the key-value pair, false otherwise.

"Size" Operation

Request Message Type Id:0x020a, Retryable:Yes

Returns the number of key-value pairs in the multimap.

Response Message Type Id:102

The number of key-value pairs in the multimap.

"Clear" Operation

Request Message Type Id:0x020b, Retryable:No

Clears the multimap. Removes all key-value pairs.

Response Message Type Id:100

Header only response message, no message body exist.

"ValueCount" Operation

Request Message Type Id:0x020c, Retryable:Yes

Returns the number of values that match the given key in the multimap.

Response Message Type Id:102

The number of values that match the given key in the multimap

"AddEntryListenerToKey" Operation

Request Message Type Id:0x020d, Retryable:Yes

Adds the specified entry listener for the specified key.The listener will be notified for all
add/remove/update/evict events for the specified key only.

Response Message Type Id:104

Returns registration id for the entry listener

"Entry" Event Message

Message Type Id:203

"AddEntryListener" Operation

Request Message Type Id:0x020e, Retryable:Yes

Adds an entry listener for this multimap. The listener will be notified for all multimap add/remove/update/evict events.

Response Message Type Id:104

Returns registration id for the entry listener

"Entry" Event Message

Message Type Id:203

"RemoveEntryListener" Operation

Request Message Type Id:0x020f, Retryable:No

Removes the specified entry listener. Returns silently if no such listener was added before.

Response Message Type Id:101

True if registration is removed, false otherwise

"Lock" Operation

Request Message Type Id:0x0210, Retryable:No

Acquires the lock for the specified key for the specified lease time. After the lease time, the lock will be
released. If the lock is not available, then the current thread becomes disabled for thread scheduling
purposes and lies dormant until the lock has been acquired. Scope of the lock is for this map only. The acquired
lock is only for the key in this map.Locks are re-entrant, so if the key is locked N times, then it should be
unlocked N times before another thread can acquire it.

Response Message Type Id:100

Header only response message, no message body exist.

"TryLock" Operation

Request Message Type Id:0x0211, Retryable:No

Tries to acquire the lock for the specified key for the specified lease time. After lease time, the lock will be
released. If the lock is not available, then the current thread becomes disabled for thread scheduling purposes
and lies dormant until one of two things happens:the lock is acquired by the current thread, or the specified
waiting time elapses.

Response Message Type Id:101

True if the lock was acquired and false if the waiting time elapsed before the lock acquired

"IsLocked" Operation

Request Message Type Id:0x0212, Retryable:Yes

Checks the lock for the specified key. If the lock is acquired, this method returns true, else it returns false.

Response Message Type Id:101

True if the lock acquired,false otherwise

"Unlock" Operation

Request Message Type Id:0x0213, Retryable:No

Releases the lock for the specified key regardless of the lock owner. It always successfully unlocks the key,
never blocks and returns immediately.

Response Message Type Id:100

Header only response message, no message body exist.

"ForceUnlock" Operation

Request Message Type Id:0x0214, Retryable:No

Releases the lock for the specified key regardless of the lock owner. It always successfully unlocks the key,
never blocks and returns immediately.

Response Message Type Id:100

Header only response message, no message body exist.

"RemoveEntry" Operation

Request Message Type Id:0x0215, Retryable:No

Removes all the entries with the given key. The collection is NOT backed by the map, so changes to the map are
NOT reflected in the collection, and vice-versa.

Response Message Type Id:101

True if the size of the multimap changed after the remove operation, false otherwise.

Queue Object

"Offer" Operation

Request Message Type Id:0x0301, Retryable:No

Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to
become available.

Response Message Type Id:101

True if the element was added to this queue, else false

"Put" Operation

Request Message Type Id:0x0302, Retryable:No

Inserts the specified element into this queue, waiting if necessary for space to become available.

Response Message Type Id:100

Header only response message, no message body exist.

"Size" Operation

Request Message Type Id:0x0303, Retryable:No

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE

Response Message Type Id:102

The number of elements in this collection

"Remove" Operation

Request Message Type Id:0x0304, Retryable:No

Retrieves and removes the head of this queue. This method differs from poll only in that it throws an exception
if this queue is empty.

Response Message Type Id:101

true if this queue changed as a result of the call

"Poll" Operation

Request Message Type Id:0x0305, Retryable:No

Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element
to become available.

Response Message Type Id:105

The head of this queue, or null if this queue is empty

"Take" Operation

Request Message Type Id:0x0306, Retryable:No

Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Response Message Type Id:105

The head of this queue

"Peek" Operation

Request Message Type Id:0x0307, Retryable:No

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.

Response Message Type Id:105

The head of this queue, or null if this queue is empty

"Iterator" Operation

Request Message Type Id:0x0308, Retryable:No

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which
the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Response Message Type Id:106

list of all data in queue

"DrainTo" Operation

Request Message Type Id:0x0309, Retryable:No

Removes all available elements from this queue and adds them to the given collection. This operation may be more
efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to
collection c may result in elements being in neither, either or both collections when the associated exception is
thrown. Attempts to drain a queue to itself result in ILLEGAL_ARGUMENT. Further, the behavior of
this operation is undefined if the specified collection is modified while the operation is in progress.

Response Message Type Id:106

list of all removed data in queue

"DrainToMaxSize" Operation

Request Message Type Id:0x030a, Retryable:No

Removes at most the given number of available elements from this queue and adds them to the given collection.
A failure encountered while attempting to add elements to collection may result in elements being in neither,
either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in
ILLEGAL_ARGUMENT. Further, the behavior of this operation is undefined if the specified collection is
modified while the operation is in progress.

Response Message Type Id:106

list of all removed data in result of this method

"Contains" Operation

Request Message Type Id:0x030b, Retryable:No

Returns true if this queue contains the specified element. More formally, returns true if and only if this queue
contains at least one element e such that value.equals(e)

Response Message Type Id:101

true if this collection contains the specified element

"ContainsAll" Operation

Request Message Type Id:0x030c, Retryable:No

Return true if this collection contains all of the elements in the specified collection.

Response Message Type Id:101

true if this collection contains all of the elements in the specified collection

"CompareAndRemoveAll" Operation

Request Message Type Id:0x030d, Retryable:No

Removes all of this collection's elements that are also contained in the specified collection (optional operation).
After this call returns, this collection will contain no elements in common with the specified collection.

Response Message Type Id:101

true if this collection changed as a result of the call

"CompareAndRetainAll" Operation

Request Message Type Id:0x030e, Retryable:No

Retains only the elements in this collection that are contained in the specified collection (optional operation).
In other words, removes from this collection all of its elements that are not contained in the specified collection.

Response Message Type Id:101

true if this collection changed as a result of the call

"Clear" Operation

Request Message Type Id:0x030f, Retryable:No

Removes all of the elements from this collection (optional operation). The collection will be empty after this
method returns.

Response Message Type Id:100

Header only response message, no message body exist.

"AddAll" Operation

Request Message Type Id:0x0310, Retryable:No

Adds all of the elements in the specified collection to this collection (optional operation).The behavior of this
operation is undefined if the specified collection is modified while the operation is in progress.
(This implies that the behavior of this call is undefined if the specified collection is this collection,
and this collection is nonempty.)

Response Message Type Id:101

true if this collection changed as a result of the call

"AddListener" Operation

Request Message Type Id:0x0311, Retryable:Yes

Adds an listener for this collection. Listener will be notified or all collection add/remove events.

Response Message Type Id:104

The registration id

"Item" Event Message

Message Type Id:204

"RemoveListener" Operation

Request Message Type Id:0x0312, Retryable:No

Removes the specified item listener.Returns silently if the specified listener was not added before.

Response Message Type Id:101

True if the item listener is removed, false otherwise

"RemainingCapacity" Operation

Request Message Type Id:0x0313, Retryable:No

Returns the number of additional elements that this queue can ideally (in the absence of memory or resource
constraints) accept without blocking, or Integer.MAX_VALUE if there is no intrinsic limit. Note that you cannot
always tell if an attempt to insert an element will succeed by inspecting remainingCapacity because it may be
the case that another thread is about to insert or remove an element.

Response Message Type Id:102

The remaining capacity

"IsEmpty" Operation

Request Message Type Id:0x0314, Retryable:No

Returns true if this collection contains no elements.

Response Message Type Id:101

True if this collection contains no elements

Topic Object

"Publish" Operation

Request Message Type Id:0x0401, Retryable:No

Publishes the message to all subscribers of this topic

Response Message Type Id:100

Header only response message, no message body exist.

"AddMessageListener" Operation

Request Message Type Id:0x0402, Retryable:Yes

Subscribes to this topic. When someone publishes a message on this topic. onMessage() function of the given
MessageListener is called. More than one message listener can be added on one instance.

Response Message Type Id:104

returns the registration id

"Topic" Event Message

Message Type Id:205

"RemoveMessageListener" Operation

Request Message Type Id:0x0403, Retryable:No

Stops receiving messages for the given message listener.If the given listener already removed, this method does nothing.

Response Message Type Id:101

True if registration is removed, false otherwise

List Object

"Size" Operation

Request Message Type Id:0x0501, Retryable:Yes

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.

Response Message Type Id:102

The number of elements in this list

"Contains" Operation

Request Message Type Id:0x0502, Retryable:Yes

Returns true if this list contains the specified element.

Response Message Type Id:101

True if this list contains the specified element, false otherwise

"ContainsAll" Operation

Request Message Type Id:0x0503, Retryable:Yes

Returns true if this list contains all of the elements of the specified collection.

Response Message Type Id:101

True if this list contains all of the elements of the
specified collection

"Add" Operation

Request Message Type Id:0x0504, Retryable:No

Appends the specified element to the end of this list (optional operation). Lists that support this operation may
place limitations on what elements may be added to this list. In particular, some lists will refuse to add null
elements, and others will impose restrictions on the type of elements that may be added. List classes should
clearly specify in their documentation any restrictions on what elements may be added.

Response Message Type Id:101

true if this list changed as a result of the call, false otherwise

"Remove" Operation

Request Message Type Id:0x0505, Retryable:No

Removes the first occurrence of the specified element from this list, if it is present (optional operation).
If this list does not contain the element, it is unchanged.
Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Response Message Type Id:101

True if this list contained the specified element, false otherwise

"AddAll" Operation

Request Message Type Id:0x0506, Retryable:No

Appends all of the elements in the specified collection to the end of this list, in the order that they are
returned by the specified collection's iterator (optional operation).
The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
(Note that this will occur if the specified collection is this list, and it's nonempty.)

Response Message Type Id:101

True if this list changed as a result of the call, false otherwise

"CompareAndRemoveAll" Operation

Request Message Type Id:0x0507, Retryable:No

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Response Message Type Id:101

True if removed at least one of the items, false otherwise.

"CompareAndRetainAll" Operation

Request Message Type Id:0x0508, Retryable:No

Retains only the elements in this list that are contained in the specified collection (optional operation).
In other words, removes from this list all of its elements that are not contained in the specified collection.

Response Message Type Id:101

True if this list changed as a result of the call, false otherwise.

"Clear" Operation

Request Message Type Id:0x0509, Retryable:No

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Response Message Type Id:100

Header only response message, no message body exist.

"GetAll" Operation

Request Message Type Id:0x050a, Retryable:Yes

Return the all elements of this collection

Response Message Type Id:106

An array of all item values in the list.

"AddListener" Operation

Request Message Type Id:0x050b, Retryable:Yes

Adds an item listener for this collection. Listener will be notified for all collection add/remove events.

Response Message Type Id:104

Registration id for the listener.

"Item" Event Message

Message Type Id:204

"RemoveListener" Operation

Request Message Type Id:0x050c, Retryable:No

Removes the specified item listener. Returns silently if the specified listener was not added before.

Response Message Type Id:101

True if unregistered, false otherwise.

"IsEmpty" Operation

Request Message Type Id:0x050d, Retryable:Yes

Returns true if this list contains no elements

Response Message Type Id:101

True if this list contains no elements

"AddAllWithIndex" Operation

Request Message Type Id:0x050e, Retryable:No

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).
The new elements will appear in this list in the order that they are returned by the specified collection's iterator.
The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
(Note that this will occur if the specified collection is this list, and it's nonempty.)

Response Message Type Id:101

True if this list changed as a result of the call, false otherwise.

"Get" Operation

Request Message Type Id:0x050f, Retryable:Yes

Returns the element at the specified position in this list

Response Message Type Id:105

The element at the specified position in this list

"Set" Operation

Request Message Type Id:0x0510, Retryable:No

The element previously at the specified position

Response Message Type Id:105

The element previously at the specified position

"AddWithIndex" Operation

Request Message Type Id:0x0511, Retryable:No

Inserts the specified element at the specified position in this list (optional operation). Shifts the element
currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Response Message Type Id:100

Header only response message, no message body exist.

"RemoveWithIndex" Operation

Request Message Type Id:0x0512, Retryable:No

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements
to the left (subtracts one from their indices). Returns the element that was removed from the list.

Response Message Type Id:105

The element previously at the specified position

"LastIndexOf" Operation

Request Message Type Id:0x0513, Retryable:Yes

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not
contain the element.

Response Message Type Id:102

the index of the last occurrence of the specified element in
this list, or -1 if this list does not contain the element

"IndexOf" Operation

Request Message Type Id:0x0514, Retryable:Yes

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not
contain the element.

Response Message Type Id:102

The index of the first occurrence of the specified element in
this list, or -1 if this list does not contain the element

"Sub" Operation

Request Message Type Id:0x0515, Retryable:Yes

Returns a view of the portion of this list between the specified from, inclusive, and to, exclusive.(If from and
to are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in
the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list
operations supported by this list.
This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays).
Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list.
Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class
can be applied to a subList.
The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is
structurally modified in any way other than via the returned list.(Structural modifications are those that change
the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Response Message Type Id:106

A view of the specified range within this list

"Iterator" Operation

Request Message Type Id:0x0516, Retryable:Yes

Returns an iterator over the elements in this list in proper sequence.

Response Message Type Id:106

An iterator over the elements in this list in proper sequence

"ListIterator" Operation

Request Message Type Id:0x0517, Retryable:Yes

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position
in the list. The specified index indicates the first element that would be returned by an initial call to
ListIterator#next next. An initial call to ListIterator#previous previous would return the element with the
specified index minus one.

Response Message Type Id:106

a list iterator over the elements in this list (in proper
sequence), starting at the specified position in the list

Set Object

"Size" Operation

Request Message Type Id:0x0601, Retryable:No

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE.

Response Message Type Id:102

The number of elements in this set (its cardinality)

"Contains" Operation

Request Message Type Id:0x0602, Retryable:No

Returns true if this set contains the specified element.

Response Message Type Id:101

True if this set contains the specified element, false otherwise

"ContainsAll" Operation

Request Message Type Id:0x0603, Retryable:No

Returns true if this set contains all of the elements of the specified collection. If the specified collection is
also a set, this method returns true if it is a subset of this set.

Response Message Type Id:101

true if this set contains all of the elements of the
specified collection

"Add" Operation

Request Message Type Id:0x0604, Retryable:No

Adds the specified element to this set if it is not already present (optional operation).
If this set already contains the element, the call leaves the set unchanged and returns false.In combination with
the restriction on constructors, this ensures that sets never contain duplicate elements.
The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular
element, including null, and throw an exception, as described in the specification for Collection
Individual set implementations should clearly document any restrictions on the elements that they may contain.

Response Message Type Id:101

True if this set did not already contain the specified
element and the element is added, returns false otherwise.

"Remove" Operation

Request Message Type Id:0x0605, Retryable:No

Removes the specified element from this set if it is present (optional operation).
Returns true if this set contained the element (or equivalently, if this set changed as a result of the call).
(This set will not contain the element once the call returns.)

Response Message Type Id:101

True if this set contained the specified element and it is removed successfully

"AddAll" Operation

Request Message Type Id:0x0606, Retryable:No

Adds all of the elements in the specified collection to this set if they're not already present
(optional operation). If the specified collection is also a set, the addAll operation effectively modifies this
set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified
collection is modified while the operation is in progress.

Response Message Type Id:101

True if this set changed as a result of the call

"CompareAndRemoveAll" Operation

Request Message Type Id:0x0607, Retryable:No

Removes from this set all of its elements that are contained in the specified collection (optional operation).
If the specified collection is also a set, this operation effectively modifies this set so that its value is the
asymmetric set difference of the two sets.

Response Message Type Id:101

true if at least one item in valueSet existed and removed, false otherwise.

"CompareAndRetainAll" Operation

Request Message Type Id:0x0608, Retryable:No

Retains only the elements in this set that are contained in the specified collection (optional operation).
In other words, removes from this set all of its elements that are not contained in the specified collection.
If the specified collection is also a set, this operation effectively modifies this set so that its value is the
intersection of the two sets.

Response Message Type Id:101

true if at least one item in valueSet existed and it is retained, false otherwise. All items not in valueSet but
in the Set are removed.

"Clear" Operation

Request Message Type Id:0x0609, Retryable:No

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Response Message Type Id:100

Header only response message, no message body exist.

"GetAll" Operation

Request Message Type Id:0x060a, Retryable:No

Return the all elements of this collection

Response Message Type Id:106

Array of all values in the Set

"AddListener" Operation

Request Message Type Id:0x060b, Retryable:Yes

Adds an item listener for this collection. Listener will be notified for all collection add/remove events.

Response Message Type Id:104

The registration id.

"Item" Event Message

Message Type Id:204

"RemoveListener" Operation

Request Message Type Id:0x060c, Retryable:No

Removes the specified item listener. Returns silently if the specified listener was not added before.

Response Message Type Id:101

true if the listener with the provided id existed and removed, false otherwise.

"IsEmpty" Operation

Request Message Type Id:0x060d, Retryable:No

Returns true if this set contains no elements.

Response Message Type Id:101

True if this set contains no elements

Lock Object

"IsLocked" Operation

Request Message Type Id:0x0701, Retryable:Yes

Returns whether this lock is locked or not.

Response Message Type Id:101

True if this lock is locked, false otherwise.