Package com.illumon.iris.controller

Class ControllerHashtable

java.lang.Object

com.illumon.iris.controller.ControllerHashtable

All Implemented Interfaces:

ControllerHashtableEventSource, Map<Long,PersistentQueryInfo>

Direct Known Subclasses:

ControllerHashtableServer, PersistentQueryControllerClient

public abstract class ControllerHashtable
extends Object
implements Map<Long,PersistentQueryInfo>, ControllerHashtableEventSource

This class provides a base for a Controller hash table.

The server maintains the authoritative version of the map. Clients can connect to the server and listen to the updates to which they subscribe. Clients can also send the server their update requests, via a separate Comm channel.

Threading rules:

• All methods are already appropriately synchronized, so you do not need any further synchronization for most tasks.
• To gain exclusive access to the data (for example, while iterating over the entries in the map), synchronize on the object returned by getData().
• The ControllerHashtable itself is not the lock for the map data!

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected final io.deephaven.hash.KeyedLongObjectHashMap<PersistentQueryInfo>	data
protected final CopyOnWriteArrayList<ControllerHashtableEventHandler>	handlers

Constructor Summary

Constructors

Constructor	Description
ControllerHashtable()

Method Summary

Modifier and Type	Method	Description
void	addEventHandler(ControllerHashtableEventHandler handler)	Subscribe to events.
void	addEventHandlerAndGetData(ControllerHashtableEventHandler handler)	Subscribe to events with an initial snapshot of the data.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<Long,PersistentQueryInfo>>	entrySet()	Note that the returned set is a view and should be synchronized when accessed.
PersistentQueryInfo	get(Object key)
final io.deephaven.hash.KeyedLongObjectHashMap<PersistentQueryInfo>	getData()	Get the internal data map for this client.
boolean	isEmpty()
Set<Long>	keySet()
protected void	notifyHandlers(ControllerHashtableEvent event)
PersistentQueryInfo	put(Long key, PersistentQueryInfo value)
void	putAll(Map<? extends Long,? extends PersistentQueryInfo> t)
PersistentQueryInfo	remove(Object key)
void	removeEventHandler(ControllerHashtableEventHandler handler)	Unsubscribe the supplied handler from further events.
int	size()
Collection<PersistentQueryInfo>	values()	Note that this breaks the contract of Map because the values are copied.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

handlers

protected final CopyOnWriteArrayList<ControllerHashtableEventHandler> handlers

data

protected final io.deephaven.hash.KeyedLongObjectHashMap<PersistentQueryInfo> data

Constructor Details

ControllerHashtable

public ControllerHashtable()

Method Details

addEventHandlerAndGetData

public void addEventHandlerAndGetData(@NotNull
 ControllerHashtableEventHandler handler)

Description copied from interface: ControllerHashtableEventSource

Subscribe to events with an initial snapshot of the data.

Specified by:

addEventHandlerAndGetData in interface ControllerHashtableEventSource

Parameters:

handler - the handler for ControllerHashTableEvents

addEventHandler

public void addEventHandler(@NotNull
 ControllerHashtableEventHandler handler)

Description copied from interface: ControllerHashtableEventSource

Subscribe to events.

Specified by:

addEventHandler in interface ControllerHashtableEventSource

Parameters:

handler - the handler for ControllerHashTableEvents

removeEventHandler

public void removeEventHandler(@NotNull
 ControllerHashtableEventHandler handler)

Description copied from interface: ControllerHashtableEventSource

Unsubscribe the supplied handler from further events.

Specified by:

removeEventHandler in interface ControllerHashtableEventSource

Parameters:

handler - the handler to unsubscribe

notifyHandlers

protected void notifyHandlers(@NotNull
 ControllerHashtableEvent event)

getData

public final io.deephaven.hash.KeyedLongObjectHashMap<PersistentQueryInfo> getData()

Get the internal data map for this client.

Returns:

the internal map of queries.

get

public PersistentQueryInfo get(@NotNull
 Object key)

Specified by:

get in interface Map<Long,PersistentQueryInfo>

put

public PersistentQueryInfo put(@NotNull
 Long key,
 @NotNull
 PersistentQueryInfo value)

Specified by:

put in interface Map<Long,PersistentQueryInfo>

clear

public void clear()

Specified by:

clear in interface Map<Long,PersistentQueryInfo>

remove

public PersistentQueryInfo remove(@NotNull
 Object key)

Specified by:

remove in interface Map<Long,PersistentQueryInfo>

size

public int size()

Specified by:

size in interface Map<Long,PersistentQueryInfo>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Long,PersistentQueryInfo>

containsKey

public boolean containsKey(@NotNull
 Object key)

Specified by:

containsKey in interface Map<Long,PersistentQueryInfo>

containsValue

public boolean containsValue(@NotNull
 Object value)

Specified by:

containsValue in interface Map<Long,PersistentQueryInfo>

values

@NotNull
public Collection<PersistentQueryInfo> values()

Note that this breaks the contract of Map because the values are copied.

Specified by:

values in interface Map<Long,PersistentQueryInfo>

putAll

public void putAll(@NotNull
 Map<? extends Long,? extends PersistentQueryInfo> t)

Specified by:

putAll in interface Map<Long,PersistentQueryInfo>

entrySet

@NotNull
public Set<Map.Entry<Long,PersistentQueryInfo>> entrySet()

Note that the returned set is a view and should be synchronized when accessed.

Specified by:

entrySet in interface Map<Long,PersistentQueryInfo>

Returns:

keySet

@NotNull
public Set<Long> keySet()

Specified by:

keySet in interface Map<Long,PersistentQueryInfo>