seda.sandStorm.api
Class SinkCloggedEvent

java.lang.Object
  seda.sandStorm.api.SinkCloggedEvent

All Implemented Interfaces:

QueueElementIF

public class SinkCloggedEvent
extends java.lang.Object
implements QueueElementIF

This event indicates that a sink was clogged when trying to process the given element. A sink is considered clogged if it is full (that is, its length threshold has been reached), or some other condition is preventing the given element from being serviced.

As opposed to SinkFullException, which is thrown immediately if attempting to enqueue onto a full sink, SinkCloggedEvent is pushed to an application if a sink becomes full asynchronously, or if some other condition caused the sink to become clogged.

See Also:

SinkFullException

Field Summary

QueueElementIF	element The element which clogged.
SinkIF	sink The sink which clogged.

Constructor Summary

SinkCloggedEvent(SinkIF sink, QueueElementIF element)
Create a new SinkCloggedEvent with the given sink and element.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

sink

public SinkIF sink

The sink which clogged.

element

public QueueElementIF element

The element which clogged.

Constructor Detail

SinkCloggedEvent

public SinkCloggedEvent(SinkIF sink,
                        QueueElementIF element)

Create a new SinkCloggedEvent with the given sink and element.