org.apache.camel
Interface PollingConsumerPollingStrategy

All Known Implementing Classes:

DefaultScheduledPollConsumer, FileConsumer, GenericFileConsumer, ScheduledBatchPollingConsumer, ScheduledPollConsumer

public interface PollingConsumerPollingStrategy

Strategy that allows Consumers to influence the PollingConsumer.

For example this is used by schedule based consumers to be able to suspend/resume upon polling using a PollingConsumer.

See Also:

EventDrivenPollingConsumer

Method Summary

void	afterPoll() Callback invoked after the poll.
long	beforePoll(long timeout) Callback invoked before the poll.
void	onInit() Callback invoked when the consumer is initialized such as when the PollingConsumer starts.

Method Detail

onInit

void onInit()
            throws Exception

Callback invoked when the consumer is initialized such as when the PollingConsumer starts.

Throws:

Exception - can be thrown if error initializing.

beforePoll

long beforePoll(long timeout)
                throws Exception

Callback invoked before the poll.

Parameters:

timeout - the timeout

Returns:

timeout to be used, this allows returning a higher timeout value to ensure at least one poll is being performed

Throws:

Exception - can be thrown if error occurred

afterPoll

void afterPoll()
               throws Exception

Callback invoked after the poll.

Throws:

Exception - can be thrown if error occurred