Class Ack
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.core.net.rabbitmq.deliveryaction.AbstractDeliveryAction
-
- adams.core.net.rabbitmq.deliveryaction.Ack
-
- All Implemented Interfaces:
adams.core.Destroyable
,adams.core.GlobalInfoSupporter
,adams.core.logging.LoggingLevelHandler
,adams.core.logging.LoggingSupporter
,adams.core.option.OptionHandler
,adams.core.QuickInfoSupporter
,adams.core.SizeOfHandler
,Serializable
public class Ack extends AbstractDeliveryAction
Acknowledges the successful processing of the message with the specified delivery tag.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
m_Multiple
whether to acknowledge all messages up to delivery tag.
-
Constructor Summary
Constructors Constructor Description Ack()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected String
doPerformAction(com.rabbitmq.client.Channel channel, long tag)
Performs the action.boolean
getMultiple()
Returns whether to acknowledge all messages up to and including delivery tag.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.String
globalInfo()
Returns a string describing the object.String
multipleTipText()
Returns the tip text for this property.void
setMultiple(boolean value)
Sets whether to acknowledge all messages up to and including delivery tag.-
Methods inherited from class adams.core.net.rabbitmq.deliveryaction.AbstractDeliveryAction
check, performAction
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.core.option.AbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classadams.core.option.AbstractOptionHandler
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceadams.core.QuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractDeliveryAction
- Returns:
- null if no info available, otherwise short string
-
setMultiple
public void setMultiple(boolean value)
Sets whether to acknowledge all messages up to and including delivery tag.- Parameters:
value
- true if ack all
-
getMultiple
public boolean getMultiple()
Returns whether to acknowledge all messages up to and including delivery tag.- Returns:
- true if ack all
-
multipleTipText
public String multipleTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
doPerformAction
protected String doPerformAction(com.rabbitmq.client.Channel channel, long tag)
Performs the action.- Specified by:
doPerformAction
in classAbstractDeliveryAction
- Parameters:
channel
- the channel to operate ontag
- the delivery tag- Returns:
- null if successful, otherwise error message
-
-