net.kuujo.vertigo.io

Class Feeder<T extends Output<T>>

java.lang.Object

net.kuujo.vertigo.io.Feeder<T>

Type Parameters:

T - The output type.

public class Feeder<T extends Output<T>>
extends Object

Provides an interface for feeding outputs using a handler that will be called whenever the given output is prepared to accept a single message.

Author:

Jordan Halterman

Constructor Summary

Constructors

Constructor and Description
Feeder(T output)

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends Output<T>> Feeder<T>	createFeeder(T output) Creates a new feeder.
Feeder<T>	feedHandler(org.vertx.java.core.Handler<T> handler) Sets a feed handler on the feeder.
long	getFeedDelay() Returns the period the feeder will wait after a failed feed handler call.
Feeder<T>	setFeedDelay(long feedDelay) Sets the period the feeder will wait before calling the feed handler again if the feed handler is called but no messages are produced.
void	start() Starts the feeder.
void	stop() Stops the feeder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Feeder

public Feeder(T output)

Method Detail

createFeeder

public static <T extends Output<T>> Feeder<T> createFeeder(T output)

Creates a new feeder.

Parameters:

output - The output to which to feed messages.

Returns:

A new feeder.

feedHandler

public Feeder<T> feedHandler(org.vertx.java.core.Handler<T> handler)

Sets a feed handler on the feeder.

Parameters:

handler - A handler to be called each time a message should be fed to the feeder.

Returns:

The feeder.

setFeedDelay

public Feeder<T> setFeedDelay(long feedDelay)

Sets the period the feeder will wait before calling the feed handler again if the feed handler is called but no messages are produced.

Parameters:

feedDelay - The feed delay in milliseconds.

Returns:

The feeder.

getFeedDelay

public long getFeedDelay()

Returns the period the feeder will wait after a failed feed handler call.

Returns:

The feed delay. Defaults to 10 milliseconds.

start

public void start()

Starts the feeder.

stop

public void stop()

Stops the feeder.