software.chronicle.datagrid.pubsub

Interface TopicSubscriber<T,M>

All Superinterfaces:

BaseSubscriber, EndOfConnection, HasUsingMessage<M>, HasUsingTopic<T>

All Known Implementing Classes:

FilteringTopicSubscriber, VanillaIndexAwareTopicSubscriber, VanillaSubAsset, VanillaTopicSubscriber

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface TopicSubscriber<T,M>
extends BaseSubscriber, HasUsingTopic<T>, HasUsingMessage<M>, EndOfConnection

Subscriber for a pair of topic and message on an Asset group.

Method Summary

Modifier and Type	Method and Description
static <T,M> TopicSubscriberBuilder<T,M>	builder(Class<T> topicClassToken, Class<M> messageClassToken) Creates and returns a new TopicSubscriberBuilder that can be used to configure and build new TopicSubscribers.
static <T,M> TopicSubscriber<T,M>	indexAware(@NotNull TopicSubscriber<T,M> topicSubscriber) Ensures that the provided topicSubscriber is index aware, if it is, returns the provided topicSubscriber or else creates and returns a new TopicSubscriber that wraps the provided topicSubscriber and that implements the methods BaseSubscriber.index(), and BaseSubscriber.index(long).
default void	onEndOfConnection() called when the connection is closed
void	onMessage(T topic, M message) This method is invoked by DataGrid when a topic in a group has an new message/event

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

index, index, isIndexAware, isTcpBufferFullEnough, onEndOfSubscription

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

usingTopic

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

usingMessage

Method Detail

onMessage

void onMessage(T topic,
               M message)
        throws InvalidSubscriberException

This method is invoked by DataGrid when a topic in a group has an new message/event

Parameters:

topic - the message was associated with

message - published

Throws:

InvalidSubscriberException - is thrown if this subscriber is no longer valid.

indexAware

static <T,M> TopicSubscriber<T,M> indexAware(@NotNull
                                             @NotNull TopicSubscriber<T,M> topicSubscriber)

Ensures that the provided topicSubscriber is index aware, if it is, returns the provided topicSubscriber or else creates and returns a new TopicSubscriber that wraps the provided topicSubscriber and that implements the methods BaseSubscriber.index(), and BaseSubscriber.index(long).

An index aware TopicSubscriber keeps track of its last known index, allowing a subscriber to be seamlessly handed over between servers.

Type Parameters:

T - topic type

M - message type

Parameters:

topicSubscriber - to wrap

Returns:

Ensures that the provided topicSubscriber is index aware, if it is, returns the provided topicSubscriber or else creates and returns a new TopicSubscriber that wraps the provided topicSubscriber and that implements the methods BaseSubscriber.index(), and BaseSubscriber.index(long)

builder

static <T,M> TopicSubscriberBuilder<T,M> builder(Class<T> topicClassToken,
                                                 Class<M> messageClassToken)

Creates and returns a new TopicSubscriberBuilder that can be used to configure and build new TopicSubscribers.

Type Parameters:

M - message type

Parameters:

topicClassToken - representing the message type

messageClassToken - representing the message type

Returns:

a new SubscriberBuilder that can be used to configure and build new Subscribers

onEndOfConnection

default void onEndOfConnection()

Description copied from interface: EndOfConnection

called when the connection is closed

Specified by:

onEndOfConnection in interface EndOfConnection