the type of the cache keys
the type of the cache values
Create a new NamedCacheClient with the specified address and cache name.
the name of the coherence NamedCache
the session with the Coherence cluster
the serializer used to ser/deser messages
true if this cache is active.
Signifies whether or not this NamedMap has been destroyed.
true if this map contains no key-value mappings.
The name of this NamedMap.
true if this cache has been released
Signifies the number of key-value mappings in this map.
the number of key-value mappings in this map
Add an index to this map.
The ValueExtractor object that is used to extract an indexable Object from a value stored in the indexed Map. Must not be null.
true iff the contents of the indexed information should be ordered false otherwise.
The Comparator object which imposes an ordering on entries in the indexed map or null if the entries' values natural ordering should be used.
A Promise
Clears all the mappings in the 'NamedMap'.
a Promise which resolves once the operation is complete
Release and destroy this cache.
Warning: This method is used to completely destroy the specified cache across the cluster. All references in the entire cluster to this cache will be invalidated, the cached data will be cleared, and all resources will be released.
Helper function for invokeAll calls.
gRPC call/event emitter
a Promise eventually resolving to Map containing the results of
performing the invokeAll operation
Return a set view of the entries contained in this map that satisfy the criteria expressed by the filter. Each element in the returned set is a MapEntry.
Unlike the entrySet() method, the set returned by this method
may not be backed by the map, so changes to the set may not be reflected
in the map, and vice-versa.
the Filter object representing the criteria that the entries of this map should satisfy
the Comparator object which imposes an ordering on
entries in the resulting set; or null if the
entries' values natural ordering should be used
a set of entries that satisfy the specified criteria
Get all the specified keys, if they are in the map. For each key that is in the map, that key and its corresponding value will be placed in the map that is returned by this method. The absence of a key in the returned map indicates that it was not in the cache, which may imply (for caches that can load behind the scenes) that the requested data could not be loaded.
an Iterable of keys that may be in this map
a Promiseresolving to a Map of keys to values for the specified keys
passed in keys
Internal method to return RequestFactory.
An instance of RequestFactory
Return the Serializer used by this client.
the Serializer used by this client
Return a set view of the keys contained in this map for entries that satisfy the criteria expressed by the filter.
Unlike the {@link keySet()} method, the set returned by this method may not be backed by the map, so changes to the set may not reflected in the map, and vice-versa.
the Filter object representing the criteria that the entries of this map should satisfy
the comparator for sorting
a set of keys for entries that satisfy the specified criteria
Obtain the next page of entries from the cache.
an opaque cookie for page tracking
a {@link ClientReadableStream} to read entries from
Obtain the next page of keys from the cache.
an opaque cookie for page tracking
a {@link ClientReadableStream} to read keys from
Release local resources associated with instance.
Remove an index from this NamedMap.
Removes an index to this NamedMap. Example:
cache.removeIndex(Extractors.extract('name'))The ValueExtractor object that is used to extract
an indexable Object from a value stored in the
indexed Map. Must not be null.
A Promise that resolves when the operation completes.
Resolve a promise.
resolution callback handler
failure callback handler
raised error, if any
callback for obtaining a resolution value
Initialize event handlers for this client.
Deserializes the provided bytes.
bytes to decode
the deserialized value
Truncates the cache. Unlike clear, this function does not generate an event for each removed entry.
a Promise which resolves once the operation is complete
Return a Set of the values contained in this map that satisfy the criteria expressed by the filter.
Unlike the `values()` method, the collection returned by this method may not be backed by the map, so changes to the collection may not be reflected in the map, and vice-versa.
the Filter object representing the criteria that the entries of this map should satisfy
the Comparator object which imposes an ordering on entries in the resulting set; or null if the entries' values natural ordering should be used
a Promise that resolves to the values in the set that satisfy
the specified criteria
Class NamedCacheClient is a client to a NamedCache which is a Map that holds resources shared among members of a cluster.
All methods in this class return a Promise that eventually either resolves to a value (as described in the NamedCache) or an error if any exception occurs during the method invocation.
This class also extends EventEmitter and emits the following events: