software.chronicle.datagrid.internal.queue

Class ChronicleQueueView<T,M>

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

software.chronicle.datagrid.internal.queue.ChronicleQueueView<T,M>

All Implemented Interfaces:

Closeable, AutoCloseable, ConcurrentMap<T,M>, Function<T,M>, Map<T,M>, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, KeyedVisitable<T,M>, Updatable<MapView<T,M>>, HasTailer<T,M>, MapView<T,M>, TopicPublisher<T,M>, QueueView<T,M>, Assetted<Object>, KeyedView, SubAssetFactory

public final class ChronicleQueueView<T,M>
extends net.openhft.chronicle.core.io.AbstractCloseable
implements QueueView<T,M>, MapView<T,M>, HasTailer<T,M>, SubAssetFactory

Nested Class Summary

Nested classes/interfaces inherited from interface software.chronicle.datagrid.queue.QueueView

QueueView.Excerpt<T,M>, QueueView.Tailer<T,M>

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

Map.Entry<K,V>

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

CHECK_THREAD_SAFETY, closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT

Method Summary

Modifier and Type	Method and Description
Asset	asset()
@NotNull net.openhft.chronicle.queue.impl.RollingChronicleQueue	chronicleQueue()
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static @NotNull ChronicleQueueView	create(@NotNull RequestContext context, @NotNull Asset asset)
<E> @NotNull Asset	createSubAsset(@NotNull VanillaAsset vanillaAsset, String name, Class<E> valueType)
@NotNull EntrySetView<T,M>	entrySet()
@Nullable QueueView.Excerpt<T,M>	excerpt(long index) Returns the QueueView.Excerpt at a given index or null if no such Excerpt exists.
protected void	finalize()
M	get(Object key)
M	getAndPut(T key, M value) Explicitly get the old value before putting a new one.
M	getAndRemove(T key) Explicitly get the old value before removing.
M	getUsing(T key, Object using) Obtain a value using a mutable buffer provided.
boolean	isEmpty()
@NotNull KeySetView<T>	keySet()
Class<T>	keyType()
long	longSize()
MapView<T,M>	mapView()
QueueView.Excerpt<T,M>	next(long index) Returns the QueueView.Excerpt immediately following the Excerpt at a given index or null if no such Excerpt exists.
@Nullable QueueView.Excerpt<T,M>	next(T topic) Returns the next unread message from the tailer with the provided topic or null if no such Excerpt exists.
@NotNull File	path()
protected void	performClose()
void	publish(T topic, M message) Publish the given message to the provided topic.
long	publishAndIndex(T topic, M message) Publish the given message to the provided topic.
@NotNull Publisher<M>	publisher(T topic) Creates and returns a new Publisher for the provided topic.
M	put(T key, M value)
void	putAll(@NotNull Map<? extends T,? extends M> m)
M	putIfAbsent(T key, M value)
Reference<M>	referenceFor(T key) Obtain a reference the value for a key
void	registerKeySubscriber(@NotNull Subscriber<? super T> subscriber) Add a Subscription for the keys changed on this Map
void	registerKeySubscriber(@NotNull Subscriber<? super T> subscriber, @NotNull Filter filter, @NotNull Set<RequestContext.Operation> contextOperations) Add a Subscription for the keys changed on this Map
void	registerSubscriber(@NotNull Subscriber<? extends MapEvent<? super T,? super M>> subscriber) Add a Subscription for the MapEvents triggered by changes on this Map.
void	registerSubscriber(@NotNull Subscriber<? extends MapEvent<? super T,? super M>> subscriber, @NotNull Filter<? extends MapEvent<? super T,? super M>> filter, @NotNull Set<RequestContext.Operation> contextOperations) Add a Subscription for the MapEvents triggered by changes on this Map.
void	registerSubscriber(T topic, @NotNull Subscriber<? super M> subscriber) Registers and associates the provided subscriber with the provided topic.
void	registerTopicSubscriber(boolean bootstrap, @NotNull TopicSubscriber<? super T,? super M> topicSubscriber) Add a subscription to this group.
void	registerTopicSubscriber(@NotNull TopicSubscriber<? super T,? super M> topicSubscriber) Add a subscription to this group.
M	remove(Object key)
boolean	remove(@NotNull Object key, Object value)
M	replace(T key, M value)
boolean	replace(T key, M oldValue, M newValue)
void	set(T key, M element)
@NotNull QueueView.Tailer<T,M>	tailer() Create and returns a new Tailer that starts from the beginning of the queue.
@NotNull QueueView.Tailer<T,M>	tailerToEnd() Create and returns a new Tailer that starts from the end of the queue.
net.openhft.chronicle.queue.impl.RollingChronicleQueue	underlying()
void	unregisterSubscriber(T topic, @NotNull Subscriber<? super M> subscriber) Unregisters and disassociates the provided subscriber from the provided topic.
void	unregisterTopicSubscriber(@NotNull TopicSubscriber<? super T,? super M> topicSubscriber) Unregister a TopicSubscriber
void	unregisterTopicSubscriber(T topic, @NotNull TopicSubscriber<? super T,? super M> topicSubscriber)
@NotNull Collection<M>	values()
Class<M>	valueType()
@NotNull net.openhft.chronicle.wire.WireType	wireType()

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, toString, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.chronicle.datagrid.tree.KeyedView

keyedView

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Methods inherited from interface software.chronicle.datagrid.map.MapView

apply, size

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

Methods inherited from interface java.util.Map

equals, hashCode

Methods inherited from interface software.chronicle.datagrid.collection.Updatable

applyTo, applyTo, asyncUpdate, asyncUpdate, syncUpdate, syncUpdate

Methods inherited from interface software.chronicle.datagrid.collection.KeyedVisitable

applyToKey, applyToKey, asyncUpdateKey, asyncUpdateKey, syncUpdateKey, syncUpdateKey

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceName, temporary

Method Detail

create

@NotNull
public static @NotNull ChronicleQueueView create(@NotNull
                                                          @NotNull RequestContext context,
                                                          @NotNull
                                                          @NotNull Asset asset)

mapView

public MapView<T,M> mapView()

chronicleQueue

@NotNull
public @NotNull net.openhft.chronicle.queue.impl.RollingChronicleQueue chronicleQueue()

keySet

@NotNull
public @NotNull KeySetView<T> keySet()

Specified by:

keySet in interface Map<T,M>

Specified by:

keySet in interface MapView<T,M>

values

@NotNull
public @NotNull Collection<M> values()

Specified by:

values in interface Map<T,M>

entrySet

@NotNull
public @NotNull EntrySetView<T,M> entrySet()

Specified by:

entrySet in interface Map<T,M>

Specified by:

entrySet in interface MapView<T,M>

getUsing

@NotNull
public M getUsing(T key,
                           Object using)

Description copied from interface: MapView

Obtain a value using a mutable buffer provided.

Specified by:

getUsing in interface MapView<T,M>

Parameters:

key - to lookup.

using - a mutable buffer

Returns:

the value.

registerTopicSubscriber

public void registerTopicSubscriber(@NotNull
                                    @NotNull TopicSubscriber<? super T,? super M> topicSubscriber)

Description copied from interface: TopicPublisher

Add a subscription to this group.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerTopicSubscriber in interface MapView<T,M>

Specified by:

registerTopicSubscriber in interface TopicPublisher<T,M>

Parameters:

topicSubscriber - to listen to events.

registerTopicSubscriber

public void registerTopicSubscriber(boolean bootstrap,
                                    @NotNull
                                    @NotNull TopicSubscriber<? super T,? super M> topicSubscriber)

Description copied from interface: TopicPublisher

Add a subscription to this group.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerTopicSubscriber in interface TopicPublisher<T,M>

topicSubscriber - to listen to events.

unregisterTopicSubscriber

public void unregisterTopicSubscriber(@NotNull
                                      @NotNull TopicSubscriber<? super T,? super M> topicSubscriber)

Description copied from interface: TopicPublisher

Unregister a TopicSubscriber

This method is asynchronous and the provided subscriber will be prevented from receiving events as some later unspecified time.

Specified by:

unregisterTopicSubscriber in interface TopicPublisher<T,M>

Parameters:

topicSubscriber - to unregister

registerKeySubscriber

public void registerKeySubscriber(@NotNull
                                  @NotNull Subscriber<? super T> subscriber)

Description copied from interface: MapView

Add a Subscription for the keys changed on this Map

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerKeySubscriber in interface MapView<T,M>

Parameters:

subscriber - to add

registerKeySubscriber

public void registerKeySubscriber(@NotNull
                                  @NotNull Subscriber<? super T> subscriber,
                                  @NotNull
                                  @NotNull Filter filter,
                                  @NotNull
                                  @NotNull Set<RequestContext.Operation> contextOperations)

Description copied from interface: MapView

Add a Subscription for the keys changed on this Map

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerKeySubscriber in interface MapView<T,M>

Parameters:

subscriber - to add

filter - a list of filter operations

contextOperations - which optional operations to consider (e.g. bootstrap and ending after bootstrap)

registerSubscriber

public void registerSubscriber(@NotNull
                               @NotNull Subscriber<? extends MapEvent<? super T,? super M>> subscriber,
                               @NotNull
                               @NotNull Filter<? extends MapEvent<? super T,? super M>> filter,
                               @NotNull
                               @NotNull Set<RequestContext.Operation> contextOperations)

Description copied from interface: MapView

Add a Subscription for the MapEvents triggered by changes on this Map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerSubscriber in interface MapView<T,M>

Parameters:

subscriber - the subscriber to the subscription

filter - to apply on keys and values

contextOperations - which optional operations to consider (e.g. bootstrap and ending after bootstrap)

unregisterSubscriber

public void unregisterSubscriber(@NotNull
                                 T topic,
                                 @NotNull
                                 @NotNull Subscriber<? super M> subscriber)

Description copied from interface: TopicPublisher

Unregisters and disassociates the provided subscriber from the provided topic.

This method is asynchronous and the provided subscriber will be prevented from receiving events as some later unspecified time.

Specified by:

unregisterSubscriber in interface TopicPublisher<T,M>

Parameters:

topic - to disassociates from the given subscriber

subscriber - to unregister

referenceFor

public Reference<M> referenceFor(T key)

Description copied from interface: MapView

Obtain a reference the value for a key

Specified by:

referenceFor in interface MapView<T,M>

Parameters:

key - to bind the reference to

Returns:

a reference object.

keyType

public Class<T> keyType()

Specified by:

keyType in interface MapView<T,M>

Returns:

the type of the keys

valueType

public Class<M> valueType()

Specified by:

valueType in interface MapView<T,M>

Returns:

the type of the values.

longSize

public long longSize()

Specified by:

longSize in interface MapView<T,M>

Returns:

the size as a long value.

getAndPut

@Nullable
public M getAndPut(T key,
                             M value)

Description copied from interface: MapView

Explicitly get the old value before putting a new one.

Specified by:

getAndPut in interface MapView<T,M>

Parameters:

key - to lookup

value - to set

Returns:

the old value or null if absent

getAndRemove

@Nullable
public M getAndRemove(T key)

Description copied from interface: MapView

Explicitly get the old value before removing.

Specified by:

getAndRemove in interface MapView<T,M>

Parameters:

key - to remove

Returns:

the old value or null if absent.

unregisterTopicSubscriber

public void unregisterTopicSubscriber(@NotNull
                                      T topic,
                                      @NotNull
                                      @NotNull TopicSubscriber<? super T,? super M> topicSubscriber)

publisher

@NotNull
public @NotNull Publisher<M> publisher(@NotNull
                                                T topic)

Description copied from interface: TopicPublisher

Creates and returns a new Publisher for the provided topic.

Specified by:

publisher in interface TopicPublisher<T,M>

Parameters:

topic - to create a Publisher for

Returns:

a new Publisher for the provided topic

registerSubscriber

public void registerSubscriber(@NotNull
                               T topic,
                               @NotNull
                               @NotNull Subscriber<? super M> subscriber)

Description copied from interface: TopicPublisher

Registers and associates the provided subscriber with the provided topic.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerSubscriber in interface TopicPublisher<T,M>

Parameters:

topic - to associate with the given subscriber

subscriber - to register

tailer

@NotNull
public @NotNull QueueView.Tailer<T,M> tailer()

Description copied from interface: HasTailer

Create and returns a new Tailer that starts from the beginning of the queue.

Specified by:

tailer in interface HasTailer<T,M>

Returns:

a new Tailer that starts from the beginning of the queue

tailerToEnd

@NotNull
public @NotNull QueueView.Tailer<T,M> tailerToEnd()

Description copied from interface: HasTailer

Create and returns a new Tailer that starts from the end of the queue.

Specified by:

tailerToEnd in interface HasTailer<T,M>

Returns:

a new Tailer that starts from the end of the queue

excerpt

@Nullable
public @Nullable QueueView.Excerpt<T,M> excerpt(long index)

Description copied from interface: QueueView

Returns the QueueView.Excerpt at a given index or null if no such Excerpt exists.

If the provided index is 0, then the excerpt at the first index is returned

If the index is not a valid index, the operation is undefined.

The Excerpt object returned may be reused between invocations of methods provided by a QueueView.

Specified by:

excerpt in interface QueueView<T,M>

Parameters:

index - gets the except at the given index, if index==0 then the first index is returned

Returns:

the except

next

public QueueView.Excerpt<T,M> next(long index)

Description copied from interface: QueueView

Returns the QueueView.Excerpt immediately following the Excerpt at a given index or null if no such Excerpt exists. This method is useful for continuously reading Excerpts in an environment where the client can switch between several servers.

In other words, assuming that the queue has not rolled, returns an excerpt who's index is the provided index + 1

If the provided index is 0, then the excerpt at the second index is returned

If the index is not a valid index, the operation is undefined.

The Excerpt object returned may be reused between invocations of methods provided by a QueueView.

Specified by:

next in interface QueueView<T,M>

Parameters:

index - the address of a previous except for which the next Excerpt is to be retrieved

Returns:

the QueueView.Excerpt immediately following the Excerpt at a given index or null if no such Excerpt exists

next

@Nullable
public @Nullable QueueView.Excerpt<T,M> next(@NotNull
                                                       T topic)

Description copied from interface: QueueView

Returns the next unread message from the tailer with the provided topic or null if no such Excerpt exists.

The Excerpt object returned may be reused between invocations of methods provided by a QueueView.

Specified by:

next in interface QueueView<T,M>

Parameters:

topic - for which the next excerpt shall be returned.

Returns:

the next unread message from the tailer with the provided topic or null if no such Excerpt exists

set

public void set(T key,
                M element)

Specified by:

set in interface KeyedVisitable<T,M>

Parameters:

key - to set within this collection.

element - replace the current state of the visitable Asset

publish

public void publish(@NotNull
                    T topic,
                    @NotNull
                    M message)

Description copied from interface: TopicPublisher

Publish the given message to the provided topic.

Specified by:

publish in interface TopicPublisher<T,M>

Parameters:

topic - to publish to

message - to publish.

publishAndIndex

public long publishAndIndex(@NotNull
                            T topic,
                            @Nullable
                            M message)

Description copied from interface: QueueView

Publish the given message to the provided topic.

Specified by:

publishAndIndex in interface QueueView<T,M>

Parameters:

topic - to publish to

message - to publish.

Returns:

the index in the chronicle queue that the message was written or 0, if this information is not available

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<T,M>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<T,M>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<T,M>

get

public M get(Object key)

Specified by:

get in interface Map<T,M>

Specified by:

get in interface KeyedVisitable<T,M>

Parameters:

key - to get within this collection.

Returns:

the current state of a visitable Asset

put

public M put(T key,
             M value)

Specified by:

put in interface Map<T,M>

remove

public M remove(Object key)

Specified by:

remove in interface Map<T,M>

putAll

public void putAll(@NotNull
                   @NotNull Map<? extends T,? extends M> m)

Specified by:

putAll in interface Map<T,M>

clear

public void clear()

Specified by:

clear in interface Map<T,M>

path

@NotNull
public @NotNull File path()

wireType

@NotNull
public @NotNull net.openhft.chronicle.wire.WireType wireType()

performClose

protected void performClose()

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

registerSubscriber

public void registerSubscriber(@NotNull
                               @NotNull Subscriber<? extends MapEvent<? super T,? super M>> subscriber)

Description copied from interface: MapView

Add a Subscription for the MapEvents triggered by changes on this Map.

Any given instance of a subscriber must at most be registered once with a DataGrid instance at any given time.

This method is asynchronous and the provided subscriber will be eligible for receiving events as some later unspecified time.

Specified by:

registerSubscriber in interface MapView<T,M>

Parameters:

subscriber - the subscriber to the subscription

createSubAsset

@NotNull
public <E> @NotNull Asset createSubAsset(@NotNull
                                                  @NotNull VanillaAsset vanillaAsset,
                                                  String name,
                                                  Class<E> valueType)

Specified by:

createSubAsset in interface SubAssetFactory

putIfAbsent

public M putIfAbsent(@NotNull
                     T key,
                     M value)

Specified by:

putIfAbsent in interface ConcurrentMap<T,M>

Specified by:

putIfAbsent in interface Map<T,M>

remove

public boolean remove(@NotNull
                      @NotNull Object key,
                      Object value)

Specified by:

remove in interface ConcurrentMap<T,M>

Specified by:

remove in interface Map<T,M>

replace

public boolean replace(@NotNull
                       T key,
                       @NotNull
                       M oldValue,
                       @NotNull
                       M newValue)

Specified by:

replace in interface ConcurrentMap<T,M>

Specified by:

replace in interface Map<T,M>

replace

public M replace(@NotNull
                 T key,
                 @NotNull
                 M value)

Specified by:

replace in interface ConcurrentMap<T,M>

Specified by:

replace in interface Map<T,M>

asset

public Asset asset()

Specified by:

asset in interface Assetted<Object>

Returns:

The Asset this resource is associated with.

underlying

public net.openhft.chronicle.queue.impl.RollingChronicleQueue underlying()

Specified by:

underlying in interface Assetted<Object>

Returns:

The Underlying view this view is built on.