de.otto.synapse.eventsource

Interface EventSource

All Known Implementing Classes:

AbstractEventSource, DefaultEventSource, DelegateEventSource

public interface EventSource

An event source of events.

Event sources can be consumed by consumers.

Method Summary

Modifier and Type	Method and Description
default ChannelPosition	consume() Consumes all events from the EventSource, until the (current) end of the stream is reached.
default ChannelPosition	consume(ChannelPosition startFrom) Consumes all events from the EventSource, beginning with startFrom, until the (current) end of the stream is reached.
ChannelPosition	consumeUntil(ChannelPosition startFrom, java.time.Instant until) Consumes all events from the EventSource, beginning with startFrom, until the stopCondition is met.
default ChannelPosition	consumeUntil(java.time.Instant until) Consumes all events from the EventSource until the timestamp is reached.
java.lang.String	getChannelName() Returns the name of the EventSource.
MessageDispatcher	getMessageDispatcher() Returns the MessageDispatcher used by the EventSource to translate and sent incoming messages to the registered message consumers.
MessageLogReceiverEndpoint	getMessageLogReceiverEndpoint() Returns the MessageLogReceiverEndpoint used by the EventSource to consume events.
boolean	isStopping()
void	register(MessageConsumer<?> messageConsumer) Registers a new EventConsumer at the EventSource.
void	stop()

Method Detail

register

void register(MessageConsumer<?> messageConsumer)

Registers a new EventConsumer at the EventSource. consumers have to be thread safe as it may be called from multiple threads (e.g. for kinesis streams there is one thread per shard)

Parameters:

messageConsumer - registered EventConsumer

getMessageDispatcher

@Nonnull
MessageDispatcher getMessageDispatcher()

Returns the MessageDispatcher used by the EventSource to translate and sent incoming messages to the registered message consumers.

Returns:

MessageDispatcher

getMessageLogReceiverEndpoint

@Nonnull
MessageLogReceiverEndpoint getMessageLogReceiverEndpoint()

Returns the MessageLogReceiverEndpoint used by the EventSource to consume events.

Returns:

MessageLogReceiverEndpoint

getChannelName

java.lang.String getChannelName()

Returns the name of the EventSource.

For streaming event-sources, this is the name of the event stream.

Returns:

name

consume

default ChannelPosition consume()

Consumes all events from the EventSource, until the (current) end of the stream is reached.

The registered consumers will be called zero or more times, depending on the number of events retrieved from the EventSource.

Returns:

the new read position

consume

default ChannelPosition consume(ChannelPosition startFrom)

Consumes all events from the EventSource, beginning with startFrom, until the (current) end of the stream is reached.

The registered consumers will be called zero or more times, depending on the number of events retrieved from the EventSource.

Parameters:

startFrom - the read position returned from earlier executions

Returns:

the new read position

consumeUntil

default ChannelPosition consumeUntil(@Nonnull
                                     java.time.Instant until)

Consumes all events from the EventSource until the timestamp is reached.

The registered consumers will be called zero or more times, depending on the number of events retrieved from the EventSource.

Parameters:

until - the timestamp until the messages should be consumed

Returns:

the new read position

consumeUntil

@Nonnull
ChannelPosition consumeUntil(@Nonnull
                                      ChannelPosition startFrom,
                                      @Nonnull
                                      java.time.Instant until)

Consumes all events from the EventSource, beginning with startFrom, until the stopCondition is met.

The registered consumers will be called zero or more times, depending on the number of events retrieved from the EventSource.

Parameters:

startFrom - the read position returned from earlier executions

until - the arrival timestamp until the messages should be consumed

Returns:

the new read position

stop

void stop()

isStopping

boolean isStopping()