software.chronicle.datagrid.pubsub

Interface BaseSubscriberBuilder<B extends BaseSubscriberBuilder<B,S,M>,S,M>

All Known Subinterfaces:

SubscriberBuilder<M>, TopicSubscriberBuilder<T,M>

All Known Implementing Classes:

VanillaSubscriberBuilder, VanillaTopicSubscriberBuilder

public interface BaseSubscriberBuilder<B extends BaseSubscriberBuilder<B,S,M>,S,M>

Method Summary

Modifier and Type	Method and Description
S	build() Creates and returns a new subscriber.
B	withEndOfSubscriptionHandler(@NotNull Runnable handler) Sets the end of subscription handler for the subscriber.
B	withIndex(long initialIndex) Sets the initial index to use if this builder builds an index aware subscriber.
B	withIndexAware() Sets that the subscriber built should be an index aware subscriber.
B	withTcpBufferFull(@NotNull BooleanSupplier tcpBufferFullSupplier) Sets the tcp buffer full supplier to use for the subscriber.
B	withUsingMessage(M usingMessage) Provides a re-usable object that will be recycled for subscriber messages.

Method Detail

withEndOfSubscriptionHandler

B withEndOfSubscriptionHandler(@NotNull
                               @NotNull Runnable handler)

Sets the end of subscription handler for the subscriber.

Parameters:

handler - to use for the subscriber

Returns:

this builder

withTcpBufferFull

B withTcpBufferFull(@NotNull
                    @NotNull BooleanSupplier tcpBufferFullSupplier)

Sets the tcp buffer full supplier to use for the subscriber.

Parameters:

tcpBufferFullSupplier - to use for the subscriber

Returns:

this builder

withIndexAware

B withIndexAware()

Sets that the subscriber built should be an index aware subscriber.

Returns:

this builder

withIndex

B withIndex(long initialIndex)

Sets the initial index to use if this builder builds an index aware subscriber.

Parameters:

initialIndex - for the subscriber

Returns:

this builder

withUsingMessage

B withUsingMessage(M usingMessage)

Provides a re-usable object that will be recycled for subscriber messages.

Parameters:

usingMessage - to re-use

Returns:

this builder

build

S build()

Creates and returns a new subscriber.

Returns:

a new subscriber