# Packages

Package aggregators provides various aggregator functions and types.
Package discovery provides an implementation of Coherence NSLookup.
Package extractors provides various extractor functions and types.
Package filters provides various filter functions and types.
Package processors provides various entry processor functions and types.

# Functions

AddIndex adds the index based upon the supplied [extractors.ValueExtractor].
AddIndexWithComparator adds the index based upon the supplied [extractors.ValueExtractor] and comparator.
Aggregate performs an aggregating operation (identified by aggregator) against all the entries in a [NamedMap] or [NamedCache].
AggregateFilter performs an aggregating operation (identified by aggregator) against the set of entries selected by the specified filter.
AggregateKeys performs an aggregating operation (identified by aggregator) against the set of entries selected by the specified keys.
GetBlockingNamedQueue returns a new [NamedBlockingQueue].
GetNamedCache returns a [NamedCache] from a session.
GetNamedMap returns a [NamedMap] from a session.
GetNamedQueue returns a new [NamedQueue].
Invoke the specified processor against the entry mapped to the specified key.
InvokeAll invokes the specified function against all entries in a [NamedMap].
InvokeAllBlind invokes the specified function against all entries in a [NamedMap] but does not return results via a channel.
InvokeAllFilter invokes the specified function against the entries matching the specified filter.
InvokeAllFilterBlind invokes the specified function against the entries matching the specified filter but does not return results via a channel.
InvokeAllKeys invokes the specified function against the entries matching the specified keys.
InvokeAllKeysBlind invokes the specified function against the entries matching the specified keys but does not return results via a channel.
NewMapLifecycleListener creates and returns a pointer to a new [MapLifecycleListener] instance.
NewMapListener creates and returns a pointer to a new [MapListener] instance.
NewSerializer returns a new [Serializer] based upon the format and the type.
NewSession creates a new [Session] with the specified sessionOptions.
NewSessionLifecycleListener creates and returns a pointer to a new [SessionLifecycleListener] instance.
NsLookupGrpcAddresses looks up grpc proxy server addresses based upon the provided name service address provided as host:port, e.g.
RemoveIndex removes index based upon the supplied [extractors.ValueExtractor].
WithAddress returns a function to set the address for session.
WithDisconnectTimeout returns a function to set the maximum amount of time, in millis, a [Session] may remain in a disconnected state without successfully reconnecting.
WithExpiry returns a function to set the default expiry for a [NamedCache].
WithFormat returns a function to set the format for a session.
WithIgnoreInvalidCerts returns a function to set the connection to ignore invalid certificates for a session.
WithNearCache returns a function to set [NearCacheOptions].
WithPlainText returns a function to set the connection to plan text (insecure) for a session.
WithReadyTimeout returns a function to set the maximum amount of time an [NamedMap] or [NamedCache] operations may wait for the underlying gRPC channel to be ready.
WithRequestTimeout returns a function to set the request timeout in millis.
WithScope returns a function to set the scope for a session.
WithTLSCertsPath returns a function to set the (CA) certificates to be added for a session.
WithTLSClientCert returns a function to set the client certificate to be added for a session.
WithTLSClientKey returns a function to set the client key to be added for a session.
WithTLSConfig returns a function to set the tls.Config directly.

# Constants

Closed raised when the session has been closed.
Connected raised when the session has connected.
Destroyed raised when a storage for a given cache is destroyed usually as a result of a call to NamedMap.Destroy().
Disconnected raised when the session has disconnected.
EntryDeleted this event indicates that an entry has been removed from the cache.
EntryInserted this event indicates that an entry has been added to the cache.
EntryUpdated this event indicates that an entry has been updated in the cache.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Reconnected raised when the session has re-connected.
Released raised when the local resources for a cache has been released as a result of a call to NamedMap.Release().
Truncated raised when a storage for a given cache is truncated as a result of a call to NamedMap.Truncate().

# Variables

ErrClosed indicates that the session has been closed.
ErrDestroyed indicates that the NamedMap or NamedCache has been destroyed and can no-longer be used.
ErrDone indicates that there are no more entries to return.
ErrInvalidFormat indicates that the serialization format can only be JSON.
ErrInvalidFormat indicates that the serialization format can only be JSON.
ErrInvalidFormat indicates that the serialization format can only be JSON.
ErrInvalidFormat indicates that the serialization format can only be JSON.
ErrInvalidFormat indicates that the serialization format can only be JSON.
No description provided by the author
No description provided by the author
No description provided by the author
ErrReleased indicates that the NamedMap or NamedCache has been released and can no-longer be used.
ErrShutdown indicates the gRPC channel has been shutdown.

# Structs

CacheOptions holds various cache options.
Entry
Entry represents a returned entry from entryPageIterator.
JSONSerializer serializes data using JSON.
NamedCacheClient is the implementation of the [NamedCache] interface.
NamedMapClient is the implementation of the [NamedMap] interface.
NearCacheOptions defines options when creating a near cache.
QueueKey defines the key of a queue entry.
QueueOfferResult defines the result of a queue Offer().
QueuePollResult defines the result of a queue Poll().
Session provides APIs to create NamedCaches.
SessionOptions holds the session attributes like host, port, tls attributes etc.
StreamedEntry is wrapper object that wraps an error and a Key and a Value .
StreamedKey is wrapper object that wraps an error and a key.
StreamedValue is wrapper object that wraps an error and a value.

# Interfaces

CacheStats defines various statics for near caches.
MapEvent an event which indicates that the content of the NamedMap or NamedCache has changed (i.e., an entry has been added, updated, and/or removed).
No description provided by the author
MapLifecycleListener allows registering callbacks to be notified when lifecycle events (truncated or released) occur against a [NamedMap] or [NamedCache].
MapListener allows registering callbacks to be notified when mutations events occur within a [NamedMap] or [NamedCache].
NamedBlockingQueue defines a blocking Queue implementation.
NamedCache is syntactically identical in behaviour to a NamedMap, but additionally implements the PutWithExpiry operation.
NamedMap defines the APIs to cache data, mapping keys to values, supporting full concurrency of retrievals and high expected concurrency for updates.
NamedQueue defines a non-blocking Queue implementation.
Serializer defines how to serialize/ de-serialize objects.
SessionLifecycleEvent defines a session lifecycle event.
No description provided by the author

# Type aliases

InvalidationStrategyType described the type if invalidation strategies for near cache.
MapEventType describes an event raised by a cache mutation.
MapLifecycleEventType describes an event that may be raised during the lifecycle of cache.
SessionLifecycleEventType describes an event that may be raised during the lifecycle of a Session.