org.thales.punch.platform.api

Interface IExitCondition

All Known Implementing Classes:

ExitConditionImpl

public interface IExitCondition

Punch application may decide they need to stop.

Most of the time because enough data was received (i.e. acks is greater than some value), or because there are some failure (fails greater than 0).

Another likely case is to have no more activity after some data was received.

A callback must be provided when creating the exit condition. It should contain the exit protocol.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
void	evaluate() Evaluate the exit conditions and fire the callback if matched.
void	incRemainingObjects(long increment) Indicates that some remaining object is to be handled (semantics: depending on the spout)
boolean	isEnabled() State whether exit condition will be used or not
void	markAck() Signal a data ack.
void	markEmit() Signal a data emit.
void	markFail() Signal a data failure.

Method Detail

markEmit

void markEmit()

Signal a data emit.

markAck

void markAck()

Signal a data ack.

markFail

void markFail()

Signal a data failure.

incRemainingObjects

void incRemainingObjects(long increment)

Indicates that some remaining object is to be handled (semantics: depending on the spout)

Parameters:

increment -

evaluate

void evaluate()

Evaluate the exit conditions and fire the callback if matched.

isEnabled

boolean isEnabled()

State whether exit condition will be used or not