Package seda.sandStorm.api

Interface Summary

ClassQueueElementIF	A ClassQueueElementIF represents an event with an associated 'class' used for class-based admission control.
ConfigDataIF	ConfigDataIF is used to pass configuration arguments to stages.
EnqueuePredicateIF	Enqueue predicates allow users to specify a method that will 'screen' elements being enqueued onto a sink, either accepting or rejecting them.
EventHandlerIF	An EventHandlerIF represents an event handler - the basic unit of computation in SandStorm.
ManagerIF	ManagerIF represents the system manger, which provides various runtime services to applications, such as access to other stages.
ProfilableIF	An object which implements ProfilableIF can be profiled by a ProfilerIF.
ProfilerIF	A ProfilerIF is responsible for profiling the behavior of the system over time.
QueueElementIF	A QueueElementIF represents an event which is placed on, or taken off of, an event queue.
QueueIF	A QueueIF implements a finite-length event queue.
SignalIF	This is an empty interface that must be implemented by all classes representing signal events.
SignalMgrIF	This class defines an interface for delivery of systemwide 'signals', informational events that stages may wish to use for initialization or control.
SingleThreadedEventHandlerIF	This is an empty class used to indicate to the system that the given event handler should be single-threaded.
SinkIF	A SinkIF implements the 'sink' end of a finite-length event queue: it supports enqueue operations only.
SourceIF	A SourceIF implements the 'source side' of an event queue: it supports dequeue operations only.
StageIF	A StageIF represents a handle to an application stage.

Class Summary

SinkCloggedEvent	This event indicates that a sink was clogged when trying to process the given element.
SinkClosedEvent	This event indicates that a sink has closed, either intentionally by the application, or unintentionally, due to an error condition.
SinkDrainedEvent	This event indicates that a sink element was processed.
SinkFlushedEvent	This event indicates that the given sink was successfully flushed; this event is generated in response to a SinkIF.flush() call.
StagesInitializedSignal	This signal indicates that all stages specified in the initial Sandstorm configuration, or created during the init() method from a stage specified in the initial configuration, have been initialized.

Exception Summary

BadQueueElementException	This exception can be thrown if an inappropriate queue element is pushed onto a SinkIF.
EventHandlerException	This is a generic exception which an event handler can throw during event processing.
NoSuchSinkException	This exception is thrown if a sink as requested by a call to StageIF.getSink() does not exist.
NoSuchStageException	This exception is thrown if a stage as requested by a call to ManagerIF.getStage() does not exist.
SinkClosedException	This exception is thrown if one attempts to enqueue a new element onto a sink which is closed.
SinkException	This is a generic exception which a sink can generate.
SinkFullException	This exception is thrown if a SinkIF is full; that is, that no more entries can be pushed into the SinkIF immediately.
StageNameAlreadyBoundException	This exception is thrown if a stage is created (via ManagerIF.createStage) with a name that conflicts with another stage.
UnknownEventException	This exception can be thrown if an unknown event type was received by a stage.