de.otto.synapse.eventsource

Interface EventSource

All Known Implementing Classes:

AbstractEventSource, DelegateEventSource, InMemoryEventSource

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	consumeAll() Consumes all events from the EventSource, until the (current) end of the stream is reached.
default ChannelPosition	consumeAll(ChannelPosition startFrom) Consumes all events from the EventSource, beginning with startFrom, until the (current) end of the stream is reached.
ChannelPosition	consumeAll(ChannelPosition startFrom, java.util.function.Predicate<Message<?>> stopCondition) Consumes all events from the EventSource, beginning with startFrom, until the stopCondition is met.
default ChannelPosition	consumeAll(java.util.function.Predicate<Message<?>> stopCondition) Consumes all events from the EventSource until the stopCondition is met.
DispatchingMessageConsumer	dispatchingMessageConsumer() Returns registered EventConsumers.
java.lang.String	getName() An event source's name is used to connect event sources to their consumers.
java.lang.String	getStreamName() Returns the name of the EventSource.
boolean	isStopping()
void	register(MessageConsumer<?> messageConsumer) Registers a new EventConsumer at the EventSource.
void	stop()

Method Detail

getName

java.lang.String getName()

An event source's name is used to connect event sources to their consumers.

Returns:

the unique name

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

dispatchingMessageConsumer

DispatchingMessageConsumer dispatchingMessageConsumer()

Returns registered EventConsumers.

Returns:

EventConsumers

getStreamName

java.lang.String getStreamName()

Returns the name of the EventSource.

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

Returns:

name

consumeAll

default ChannelPosition consumeAll()

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

consumeAll

default ChannelPosition consumeAll(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

consumeAll

default ChannelPosition consumeAll(java.util.function.Predicate<Message<?>> stopCondition)

Consumes all events from the EventSource 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:

stopCondition - the predicate used as a stop condition

Returns:

the new read position

consumeAll

ChannelPosition consumeAll(ChannelPosition startFrom,
                           java.util.function.Predicate<Message<?>> stopCondition)

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

stopCondition - the predicate used as a stop condition

Returns:

the new read position

stop

void stop()

isStopping

boolean isStopping()