com.neeve.sma
Class MessageBusBinding.FlushContext

java.lang.Object
  extended by com.neeve.sma.MessageBusBinding.FlushContext
Direct Known Subclasses:
MessageBusBinding.AsynchronousFlushContext, MessageBusBinding.SynchronousBlockingFlushContext, MessageBusBinding.SynchronousNonBlockingFlushContext
Enclosing interface:
MessageBusBinding

public abstract static class MessageBusBinding.FlushContext
extends Object

Base class for all flushing contexts.

Message bus binding and channel implementations have the prerogative to buffer outbound messages to optimize transmission throughput. Bindings support the 'flush' primitive that forces the transmission of buffered messages. A binding can be flushed using one of the following flush modes:
- synchronous
- non-blocking
- asynchronous
When the user sends message using MessageChannel.sendMessage(com.neeve.sma.MessageView, java.util.Properties, com.neeve.sma.MessageBusBinding.FlushContext, int) or flushes a binding using MessageBusBinding.flush(com.neeve.sma.MessageBusBinding.FlushContext), it needs to specify the flush mode to use for the flush. Each flush mode is represented by a flush context that holds flush mode specific information to be returned to the user. This class is the base class for all flush contexts.


Nested Class Summary
static class MessageBusBinding.FlushContext.FlushMode
          Flush modes.
 
Field Summary
 MessageBusBinding.FlushContext.FlushMode flushMode
          The flush mode.
 
Method Summary
abstract  MessageBusBinding.FlushContext reset()
          Resets the flush context before use.
 String toString()
          String representation.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

flushMode

public final MessageBusBinding.FlushContext.FlushMode flushMode
The flush mode.

Method Detail

reset

public abstract MessageBusBinding.FlushContext reset()
Resets the flush context before use.


toString

public String toString()
String representation.

Overrides:
toString in class Object


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.