software.chronicle.datagrid.pubsub

Interface Publisher<E>

All Known Subinterfaces:

Reference<E>

All Known Implementing Classes:

AuthorisedReference, MapReference, QueueReference, RemotePublisher, RemoteReference

public interface Publisher<E>

A handle to Publish to a specific topic.

Method Summary

Modifier and Type	Method and Description
void	publish(E event) Publish an event
void	registerSubscriber(boolean bootstrap, int throttlePeriodMs, Subscriber<? super E> subscriber, boolean endSubscriptionAfterBootstrap) Registers the provided subscriber as a subscription to this specific topic.
int	subscriberCount()
void	unregisterSubscriber(Subscriber<? super E> subscriber) Unregisters the provided subscriber.

Method Detail

publish

void publish(E event)

Publish an event

Parameters:

event - to publish

registerSubscriber

void registerSubscriber(boolean bootstrap,
                        int throttlePeriodMs,
                        Subscriber<? super E> subscriber,
                        boolean endSubscriptionAfterBootstrap)

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.

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

Throws:

AssetNotFoundException - if the topic no longer exists

unregisterSubscriber

void unregisterSubscriber(Subscriber<? super E> subscriber)

Unregisters the provided subscriber.

Parameters:

subscriber - to remove

subscriberCount

int subscriberCount()

Returns:

the number of subscriptions.