io.serialized.client.feed

Class FeedClient

java.lang.Object

io.serialized.client.feed.FeedClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class FeedClient
extends Object
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeedClient.Builder

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(UUID subscriptionId) Terminates a subscription by shutting down its executor.
FeedResponse	execute(GetFeedRequest request, long since) Executes a poll starting at given sequence number.
long	execute(GetSequenceNumberRequest request) Gets the current sequence number for current feed.
List<Feed>	execute(ListFeedsRequest request)
static FeedClient.Builder	feedClient(SerializedClientConfig config)
UUID	subscribe(GetFeedRequest request, FeedEntryBatchHandler feedEntryBatchHandler) Starts subscribing to the feed.
UUID	subscribe(GetFeedRequest request, FeedEntryHandler feedEntryHandler) Starts subscribing to the feed.
UUID	subscribe(GetFeedRequest request, SequenceNumberTracker sequenceNumberTracker, FeedEntryBatchHandler feedEntryBatchHandler) Starts subscribing to the feed.
UUID	subscribe(GetFeedRequest request, SequenceNumberTracker sequenceNumberTracker, FeedEntryHandler feedEntryHandler) Starts subscribing to the feed.

Methods inherited from class java.lang.Object

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

Method Detail

feedClient

public static FeedClient.Builder feedClient(SerializedClientConfig config)

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

public void close(UUID subscriptionId)

Terminates a subscription by shutting down its executor.

Parameters:

subscriptionId - ID of subscription to terminate.

execute

public FeedResponse execute(GetFeedRequest request,
                            long since)

Executes a poll starting at given sequence number.

Parameters:

since - Sequence number to start feeding from. Zero (0) starts from the beginning.

subscribe

public UUID subscribe(GetFeedRequest request,
                      FeedEntryHandler feedEntryHandler)

Starts subscribing to the feed. The default in-memory sequence number tracker will be used.

Parameters:

feedEntryHandler - Handler invoked for each received entry

Returns:

The subscription ID

See Also:

SequenceNumberTracker, InMemorySequenceNumberTracker

subscribe

public UUID subscribe(GetFeedRequest request,
                      FeedEntryBatchHandler feedEntryBatchHandler)

Starts subscribing to the feed. The default in-memory sequence number tracker will be used.

Parameters:

feedEntryBatchHandler - Handler invoked for each received batch

Returns:

The subscription ID

See Also:

SequenceNumberTracker, InMemorySequenceNumberTracker

subscribe

public UUID subscribe(GetFeedRequest request,
                      SequenceNumberTracker sequenceNumberTracker,
                      FeedEntryHandler feedEntryHandler)

Starts subscribing to the feed.

Parameters:

feedEntryHandler - Handler invoked for each received entry

Returns:

The subscription ID

subscribe

public UUID subscribe(GetFeedRequest request,
                      SequenceNumberTracker sequenceNumberTracker,
                      FeedEntryBatchHandler feedEntryBatchHandler)

Starts subscribing to the feed.

Parameters:

feedEntryBatchHandler - Handler invoked for each received batch

Returns:

The subscription ID

execute

public List<Feed> execute(ListFeedsRequest request)

Returns:

Feed names and details.

execute

public long execute(GetSequenceNumberRequest request)

Gets the current sequence number for current feed.

Note that the 'all' feed has it's own global sequence.

Returns:

The current sequence number, i.e the sequence number of the most recently stored event batch.