Package org.apache.activemq.command
Class MessagePull
java.lang.Object
org.apache.activemq.command.BaseCommand
org.apache.activemq.command.MessagePull
- All Implemented Interfaces:
Command
,DataStructure
,TransientInitializer
Used to pull messages on demand.
-
Field Summary
Modifier and TypeFieldDescriptionprotected ConsumerId
static final byte
protected ActiveMQDestination
protected long
Fields inherited from class org.apache.activemq.command.BaseCommand
commandId, responseRequired
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(ConsumerInfo info) Configures a message pull from the consumer informationAn optional correlation ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumerbyte
An optional message ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumerint
long
void
boolean
boolean
void
setAlwaysSignalDone
(boolean alwaysSignalDone) void
setConsumerId
(ConsumerId consumerId) void
setCorrelationId
(String correlationId) void
setDestination
(ActiveMQDestination destination) void
setMessageId
(MessageId messageId) void
setQuantity
(int quantity) void
setTimeout
(long timeout) void
setTracked
(boolean tracked) visit
(CommandVisitor visitor) Methods inherited from class org.apache.activemq.command.BaseCommand
copy, getCommandId, getFrom, getTo, isBrokerInfo, isConnectionControl, isConsumerControl, isMarshallAware, isMessage, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo, toString, toString
-
Field Details
-
DATA_STRUCTURE_TYPE
public static final byte DATA_STRUCTURE_TYPE- See Also:
-
consumerId
-
destination
-
timeout
protected long timeout
-
-
Constructor Details
-
MessagePull
public MessagePull()
-
-
Method Details
-
getDataStructureType
public byte getDataStructureType()- Specified by:
getDataStructureType
in interfaceDataStructure
- Returns:
- The type of the data structure
-
visit
-
configure
Configures a message pull from the consumer information -
getConsumerId
-
setConsumerId
-
getDestination
-
setDestination
-
getTimeout
public long getTimeout() -
setTimeout
public void setTimeout(long timeout) -
getCorrelationId
An optional correlation ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumer -
setCorrelationId
-
getMessageId
An optional message ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumer -
setMessageId
-
setTracked
public void setTracked(boolean tracked) -
isTracked
public boolean isTracked() -
getQuantity
public int getQuantity() -
setQuantity
public void setQuantity(int quantity) -
isAlwaysSignalDone
public boolean isAlwaysSignalDone() -
setAlwaysSignalDone
public void setAlwaysSignalDone(boolean alwaysSignalDone) -
initTransients
public void initTransients()- Specified by:
initTransients
in interfaceTransientInitializer
-