Package com.oracle.coherence.grpc.proxy

Class MapListenerProxy

java.lang.Object

com.oracle.coherence.grpc.proxy.MapListenerProxy

All Implemented Interfaces:

com.tangosol.util.MapListener<Object,Object>, io.grpc.stub.StreamObserver<MapListenerRequest>, EventListener

public class MapListenerProxy
extends Object
implements io.grpc.stub.StreamObserver<MapListenerRequest>, com.tangosol.util.MapListener<Object,Object>

A class to encapsulate bidirectional streaming of map events for a single cache.

Since:

20.06

Author:

Jonathan Knight 2019.12.03

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	MapListenerProxy.DeactivationListener	NamedCacheDeactivationListener that will communicate cache truncation and destruction events over the proxy.
protected static class	MapListenerProxy.FilterInfo	A holder for filter information.
protected static class	MapListenerProxy.KeyConverter	Converter for cache key instances.
static class	MapListenerProxy.WrapperPrimingListener	MapListenerSupport.PrimingListener that delegates calls to the wrapped MapListener.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.tangosol.util.MapListener<Object,Object>	f_listenerDeactivation	The listener used to detect cache deactivation.
protected com.tangosol.util.ConcurrentMap<com.tangosol.util.Filter<?>,MapListenerProxy.FilterInfo>	f_mapFilter	The map of Filters that this MapListenerProxy was registered with.
protected com.tangosol.util.ConcurrentMap<Object,Integer>	f_mapKeys	The map of keys that this MapListenerProxy was registered with.
protected SafeStreamObserver<MapListenerResponse>	f_observer	The StreamObserver to stream MapEvent instances to.
protected NamedCacheService	f_service	The owning NamedCacheService.
protected Set<Object>	f_setKeys	The set of keys that this MapListenerProxy was registered with.
static int	LITE	Constant to indicate that the listener is registered for "lite" events.
protected boolean	m_fCompleted
protected CacheRequestHolder<MapListenerRequest,Void>	m_holder	The CacheRequestHolder to hold the MapListenerRequest that can convert between different serialization formats.
protected MapListenerProxy.WrapperPrimingListener	m_primingListener	Wrapper map event listener.
static int	PRIMING	Constant to indicate that the listener is registered for "priming" events.

Fields inherited from interface com.tangosol.util.MapListener

ASYNCHRONOUS, SYNCHRONOUS, VERSION_AWARE

Constructor Summary

Constructors

Constructor	Description
MapListenerProxy(NamedCacheService service, io.grpc.stub.StreamObserver<MapListenerResponse> observer)	Create a MapListenerProxy to handle aMapListener subscription to a cache.

Method Summary

Modifier and Type	Method	Description
protected void	addListener(com.tangosol.util.Filter<?> filter, long filterId, boolean lite, boolean priming)	Add this MapListenerProxy as a filter-based listener of the given NamedCache.
protected void	addListener(Object key, boolean lite, boolean priming)	Add this MapListenerProxy as a key-based listener of the given NamedCache.
protected void	addListener(Object key, boolean lite, boolean priming, boolean register)	Add this MapListenerProxy as a key-based listener of the given NamedCache.
protected MapEventResponse	createMapEventResponse(com.tangosol.util.MapEvent<?,?> mapEvent)	Factory method to create new MapEventResponse instances using the information in the supplied MapEvent.
protected com.tangosol.util.MapListenerSupport.PrimingListener<Object,Object>	ensurePrimingListener()	Return the priming listener, or it not already cached, create it.
void	entryDeleted(com.tangosol.util.MapEvent<Object,Object> mapEvent)
void	entryInserted(com.tangosol.util.MapEvent<Object,Object> mapEvent)
void	entryUpdated(com.tangosol.util.MapEvent<Object,Object> mapEvent)
protected MapListenerErrorResponse	error(String uid, Throwable t)	Create a MapListenerErrorResponse.
com.tangosol.util.MapListener<Object,Object>	getDeactivationListener()	Return the MapListenerProxy.DeactivationListener for this proxy.
void	onCompleted()
void	onError(Throwable throwable)
protected void	onFilterRequest(MapListenerRequest request, com.tangosol.util.MapTrigger<com.tangosol.util.Binary,com.tangosol.util.Binary> trigger)	Invoked when MapListenerRequest.RequestType is KEY.
protected void	onKeyRequest(MapListenerRequest request, com.tangosol.util.MapTrigger<?,?> trigger)	Invoked when MapListenerRequest.RequestType is KEY.
protected void	onMapEvent(com.tangosol.util.MapEvent<?,?> event)	Convert a MapEvent into a MapEventResponse and send it to the StreamObserver, converting theBinary key and values if required.
void	onNext(MapListenerRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tangosol.util.MapListener

characteristics, isAsynchronous, isSynchronous, isVersionAware, synchronous

Field Detail

LITE

public static final int LITE

Constant to indicate that the listener is registered for "lite" events.

See Also:

Constant Field Values

PRIMING

public static final int PRIMING

Constant to indicate that the listener is registered for "priming" events.

See Also:

Constant Field Values

m_fCompleted

protected volatile boolean m_fCompleted

f_service

protected final NamedCacheService f_service

The owning NamedCacheService.

f_observer

protected final SafeStreamObserver<MapListenerResponse> f_observer

The StreamObserver to stream MapEvent instances to.

f_mapFilter

protected final com.tangosol.util.ConcurrentMap<com.tangosol.util.Filter<?>,MapListenerProxy.FilterInfo> f_mapFilter

The map of Filters that this MapListenerProxy was registered with.

f_mapKeys

protected final com.tangosol.util.ConcurrentMap<Object,Integer> f_mapKeys

The map of keys that this MapListenerProxy was registered with.

f_setKeys

protected final Set<Object> f_setKeys

The set of keys that this MapListenerProxy was registered with.

f_listenerDeactivation

protected final com.tangosol.util.MapListener<Object,Object> f_listenerDeactivation

The listener used to detect cache deactivation.

m_holder

protected CacheRequestHolder<MapListenerRequest,Void> m_holder

The CacheRequestHolder to hold the MapListenerRequest that can convert between different serialization formats.

m_primingListener

protected volatile MapListenerProxy.WrapperPrimingListener m_primingListener

Wrapper map event listener. This listener registration should force a synthetic event containing the current value to the requesting client.

Constructor Detail

MapListenerProxy

public MapListenerProxy(NamedCacheService service,
                        io.grpc.stub.StreamObserver<MapListenerResponse> observer)

Create a MapListenerProxy to handle aMapListener subscription to a cache.

Parameters:

service - the NamedCacheService to proxy

observer - the StreamObserver to stream MapEvent instances to

Method Detail

onNext

public void onNext(MapListenerRequest request)

Specified by:

onNext in interface io.grpc.stub.StreamObserver<MapListenerRequest>

onError

public void onError(Throwable throwable)

Specified by:

onError in interface io.grpc.stub.StreamObserver<MapListenerRequest>

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface io.grpc.stub.StreamObserver<MapListenerRequest>

entryInserted

public void entryInserted(com.tangosol.util.MapEvent<Object,Object> mapEvent)

Specified by:

entryInserted in interface com.tangosol.util.MapListener<Object,Object>

entryUpdated

public void entryUpdated(com.tangosol.util.MapEvent<Object,Object> mapEvent)

Specified by:

entryUpdated in interface com.tangosol.util.MapListener<Object,Object>

entryDeleted

public void entryDeleted(com.tangosol.util.MapEvent<Object,Object> mapEvent)

Specified by:

entryDeleted in interface com.tangosol.util.MapListener<Object,Object>

getDeactivationListener

public com.tangosol.util.MapListener<Object,Object> getDeactivationListener()

Return the MapListenerProxy.DeactivationListener for this proxy.

Returns:

the MapListenerProxy.DeactivationListener for this proxy

onKeyRequest

protected void onKeyRequest(MapListenerRequest request,
                            com.tangosol.util.MapTrigger<?,?> trigger)

Invoked when MapListenerRequest.RequestType is KEY.

Parameters:

request - the MapListenerRequest

trigger - the MapTrigger

onFilterRequest

protected void onFilterRequest(MapListenerRequest request,
                               com.tangosol.util.MapTrigger<com.tangosol.util.Binary,com.tangosol.util.Binary> trigger)

Invoked when MapListenerRequest.RequestType is KEY.

Parameters:

request - the MapListenerRequest

trigger - the MapTrigger

addListener

protected void addListener(com.tangosol.util.Filter<?> filter,
                           long filterId,
                           boolean lite,
                           boolean priming)

Add this MapListenerProxy as a filter-based listener of the given NamedCache.

Parameters:

filter - the Filter to listen to

filterId - the unique positive identifier of the Filter

lite - true to add a "lite" listener

priming - true if the listener is a priming listener

addListener

protected void addListener(Object key,
                           boolean lite,
                           boolean priming)

Add this MapListenerProxy as a key-based listener of the given NamedCache.

Parameters:

key - the key to listen to deserialized in Object form

lite - true to add a "lite" listener

priming - true if the listener is a priming listener

addListener

protected void addListener(Object key,
                           boolean lite,
                           boolean priming,
                           boolean register)

Add this MapListenerProxy as a key-based listener of the given NamedCache.

Parameters:

key - the key to listen to deserialized in Object form

lite - true to add a "lite" listener

priming - true if the listener is a priming listener

register - true if the listener should be added to the underlying cache

ensurePrimingListener

protected com.tangosol.util.MapListenerSupport.PrimingListener<Object,Object> ensurePrimingListener()

Return the priming listener, or it not already cached, create it.

Returns:

the priming listener

onMapEvent

protected void onMapEvent(com.tangosol.util.MapEvent<?,?> event)

Convert a MapEvent into a MapEventResponse and send it to the StreamObserver, converting theBinary key and values if required.

Parameters:

event - the event to send to the observer

createMapEventResponse

protected MapEventResponse createMapEventResponse(com.tangosol.util.MapEvent<?,?> mapEvent)

Factory method to create new MapEventResponse instances using the information in the supplied MapEvent.

Parameters:

mapEvent - the MapEvent used to configure the newly created MapEventResponse

Returns:

a MapEventResponse created from the MapEvent

error

protected MapListenerErrorResponse error(String uid,
                                         Throwable t)

Create a MapListenerErrorResponse.

Parameters:

uid - the UID of the request

t - the error that occurred

Returns:

a MapListenerErrorResponse.