software.chronicle.datagrid.internal.pubsub

Class QueueReference<T,M>

java.lang.Object

software.chronicle.datagrid.internal.pubsub.QueueReference<T,M>

All Implemented Interfaces:

Supplier<M>, Visitable<M>, Publisher<M>, Reference<M>

public final class QueueReference<T,M>
extends Object
implements Reference<M>

Constructor Summary

Constructors

Constructor and Description
QueueReference(Class<M> type, @NotNull Asset asset, @NotNull QueueView<T,M> queueView, T name)
QueueReference(@NotNull RequestContext requestContext, @NotNull Asset asset, QueueView<T,M> queueView)

Method Summary

Modifier and Type	Method and Description
M	get() Returns the current value for this Reference.
Class<M>	getType() Returns the type of the underlying reference.
void	registerSubscriber(boolean bootstrap, int throttlePeriodMs, @NotNull Subscriber<? super M> subscriber, boolean endSubscriptionAfterBootstrap) Registers the provided subscriber as a subscription to this specific topic.
void	remove() Removes the underlying topic/key for this Reference.
long	set(M event) Sets a new value for this Reference.
int	subscriberCount()
void	unregisterSubscriber(Subscriber<? super M> subscriber) Unregisters the provided subscriber.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.chronicle.datagrid.pubsub.Reference

getAndRemove, getAndSet, publish

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

applyTo, applyTo, asyncUpdate, asyncUpdate, syncUpdate, syncUpdate

Constructor Detail

QueueReference

public QueueReference(Class<M> type,
                      @NotNull
                      @NotNull Asset asset,
                      @NotNull
                      @NotNull QueueView<T,M> queueView,
                      T name)

QueueReference

public QueueReference(@NotNull
                      @NotNull RequestContext requestContext,
                      @NotNull
                      @NotNull Asset asset,
                      QueueView<T,M> queueView)

Method Detail

set

public long set(@NotNull
                M event)

Description copied from interface: Reference

Sets a new value for this Reference.

Specified by:

set in interface Visitable<M>

Specified by:

set in interface Reference<M>

Parameters:

event - replace value

Returns:

the index if this is a reference to a Queue topic or else 0.

get

@Nullable
public M get()

Description copied from interface: Reference

Returns the current value for this Reference.

Specified by:

get in interface Supplier<M>

Specified by:

get in interface Visitable<M>

Specified by:

get in interface Reference<M>

Returns:

the current value.

remove

public void remove()

Description copied from interface: Reference

Removes the underlying topic/key for this Reference. Remove the topic/key

Specified by:

remove in interface Reference<M>

registerSubscriber

public void registerSubscriber(boolean bootstrap,
                               int throttlePeriodMs,
                               @NotNull
                               @NotNull Subscriber<? super M> subscriber,
                               boolean endSubscriptionAfterBootstrap)

Description copied from interface: Publisher

Registers the provided subscriber as a subscription to this specific topic.

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

Specified by:

registerSubscriber in interface Publisher<M>

Parameters:

bootstrap - to bootstrap

throttlePeriodMs - 0 for no throttling, otherwise the period of throttling in milliseconds

subscriber - to register

endSubscriptionAfterBootstrap - if the subscriptions should be ended automatically after bootstrap

unregisterSubscriber

public void unregisterSubscriber(Subscriber<? super M> subscriber)

Description copied from interface: Publisher

Unregisters the provided subscriber.

Specified by:

unregisterSubscriber in interface Publisher<M>

Parameters:

subscriber - to remove

subscriberCount

public int subscriberCount()

Specified by:

subscriberCount in interface Publisher<M>

Returns:

the number of subscriptions.

getType

public Class<M> getType()

Description copied from interface: Reference

Returns the type of the underlying reference.

Specified by:

getType in interface Reference<M>

Returns:

the type of the underlying reference.