public class ConsumerInfo extends BaseCommand
Modifier and Type | Field and Description |
---|---|
protected BooleanExpression |
additionalPredicate |
protected BrokerId[] |
brokerPath |
protected boolean |
browser |
protected ConsumerId |
consumerId |
protected int |
currentPrefetchSize |
static byte |
DATA_STRUCTURE_TYPE |
protected ActiveMQDestination |
destination |
protected boolean |
dispatchAsync |
protected boolean |
exclusive |
static byte |
HIGH_PRIORITY |
static byte |
LOW_PRIORITY |
protected int |
maximumPendingMessageLimit |
static byte |
NETWORK_CONSUMER_PRIORITY |
protected List<ConsumerId> |
networkConsumerIds |
protected boolean |
networkSubscription |
protected boolean |
noLocal |
protected boolean |
noRangeAcks |
static byte |
NORMAL_PRIORITY |
protected boolean |
optimizedAcknowledge |
protected int |
prefetchSize |
protected byte |
priority |
protected boolean |
retroactive |
protected String |
selector |
protected String |
subscriptionName |
commandId, responseRequired
Constructor and Description |
---|
ConsumerInfo() |
ConsumerInfo(ConsumerId consumerId) |
ConsumerInfo(SessionInfo sessionInfo,
long consumerId) |
Modifier and Type | Method and Description |
---|---|
void |
addNetworkConsumerId(ConsumerId networkConsumerId) |
ConsumerInfo |
copy() |
void |
copy(ConsumerInfo info) |
RemoveInfo |
createRemoveCommand() |
BooleanExpression |
getAdditionalPredicate()
A transient additional predicate that can be used it inject additional
predicates into the selector on the fly.
|
BrokerId[] |
getBrokerPath()
The route of brokers the command has moved through.
|
ConsumerId |
getConsumerId()
Is used to uniquely identify the consumer to the broker.
|
int |
getCurrentPrefetchSize() |
byte |
getDataStructureType() |
ActiveMQDestination |
getDestination()
The destination that the consumer is interested in receiving messages
from.
|
long |
getLastDeliveredSequenceId() |
int |
getMaximumPendingMessageLimit()
How many messages a broker will keep around, above the prefetch limit,
for non-durable topics before starting to discard older messages.
|
List<ConsumerId> |
getNetworkConsumerIds() |
ConsumerId[] |
getNetworkConsumerPath()
Tracks the original subscription id that causes a subscription to
percolate through a network when networkTTL > 1.
|
int |
getPrefetchSize()
How many messages a broker will send to the client without receiving an
ack before he stops dispatching messages to the client.
|
byte |
getPriority()
The broker will avoid dispatching to a lower priority consumer if there
are other higher priority consumers available to dispatch to.
|
String |
getSelector()
The JMS selector used to filter out messages that this consumer is
interested in.
|
String |
getSubcriptionName()
Deprecated.
|
String |
getSubscriptionName()
Used to identify the name of a durable subscription.
|
boolean |
isBrowser()
Is this consumer a queue browser?
|
boolean |
isDispatchAsync()
Should the broker dispatch a message to the consumer async? If he does it
async, then he uses a more SEDA style of processing while if it is not
done async, then he broker use a STP style of processing.
|
boolean |
isDurable() |
boolean |
isExclusive()
An exclusive consumer locks out other consumers from being able to
receive messages from the destination.
|
boolean |
isNetworkConsumersEmpty() |
boolean |
isNetworkSubscription() |
boolean |
isNoLocal()
Set noLocal to true to avoid receiving messages that were published
locally on the same connection.
|
boolean |
isNoRangeAcks()
The broker may be able to optimize it's processing or provides better QOS
if it knows the consumer will not be sending ranged acks.
|
boolean |
isOptimizedAcknowledge() |
boolean |
isRetroactive()
A retroactive consumer only has meaning for Topics.
|
void |
removeNetworkConsumerId(ConsumerId networkConsumerId) |
void |
setAdditionalPredicate(BooleanExpression additionalPredicate) |
void |
setBrokerPath(BrokerId[] brokerPath) |
void |
setBrowser(boolean browser) |
void |
setConsumerId(ConsumerId consumerId) |
void |
setCurrentPrefetchSize(int currentPrefetchSize) |
void |
setDestination(ActiveMQDestination destination) |
void |
setDispatchAsync(boolean dispatchAsync) |
void |
setExclusive(boolean exclusive) |
void |
setLastDeliveredSequenceId(long lastDeliveredSequenceId) |
void |
setMaximumPendingMessageLimit(int maximumPendingMessageLimit) |
void |
setNetworkConsumerPath(ConsumerId[] consumerPath) |
void |
setNetworkSubscription(boolean networkSubscription) |
void |
setNoLocal(boolean noLocal) |
void |
setNoRangeAcks(boolean noRangeAcks) |
void |
setOptimizedAcknowledge(boolean optimizedAcknowledge) |
void |
setPrefetchSize(int prefetchSize) |
void |
setPriority(byte priority) |
void |
setRetroactive(boolean retroactive) |
void |
setSelector(String selector) |
void |
setSubcriptionName(String durableSubscriptionId)
Deprecated.
|
void |
setSubscriptionName(String durableSubscriptionId) |
Response |
visit(CommandVisitor visitor) |
copy, getCommandId, getFrom, getTo, isBrokerInfo, isConnectionControl, isMarshallAware, isMessage, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo, toString, toString
public static final byte DATA_STRUCTURE_TYPE
public static final byte HIGH_PRIORITY
public static final byte NORMAL_PRIORITY
public static final byte NETWORK_CONSUMER_PRIORITY
public static final byte LOW_PRIORITY
protected ConsumerId consumerId
protected ActiveMQDestination destination
protected int prefetchSize
protected int maximumPendingMessageLimit
protected boolean browser
protected boolean dispatchAsync
protected String selector
protected String subscriptionName
protected boolean noLocal
protected boolean exclusive
protected boolean retroactive
protected byte priority
protected BrokerId[] brokerPath
protected boolean optimizedAcknowledge
protected transient int currentPrefetchSize
protected boolean noRangeAcks
protected BooleanExpression additionalPredicate
protected transient boolean networkSubscription
protected transient List<ConsumerId> networkConsumerIds
public ConsumerInfo()
public ConsumerInfo(ConsumerId consumerId)
public ConsumerInfo(SessionInfo sessionInfo, long consumerId)
public ConsumerInfo copy()
public void copy(ConsumerInfo info)
public boolean isDurable()
public byte getDataStructureType()
public ConsumerId getConsumerId()
public void setConsumerId(ConsumerId consumerId)
public boolean isBrowser()
public void setBrowser(boolean browser)
public ActiveMQDestination getDestination()
public void setDestination(ActiveMQDestination destination)
public int getPrefetchSize()
public void setPrefetchSize(int prefetchSize)
public int getMaximumPendingMessageLimit()
public void setMaximumPendingMessageLimit(int maximumPendingMessageLimit)
public boolean isDispatchAsync()
public void setDispatchAsync(boolean dispatchAsync)
public String getSelector()
public void setSelector(String selector)
public String getSubscriptionName()
public void setSubscriptionName(String durableSubscriptionId)
public String getSubcriptionName()
getSubscriptionName
public void setSubcriptionName(String durableSubscriptionId)
durableSubscriptionId
- setSubscriptionName
public boolean isNoLocal()
public void setNoLocal(boolean noLocal)
public boolean isExclusive()
public void setExclusive(boolean exclusive)
public boolean isRetroactive()
public void setRetroactive(boolean retroactive)
public RemoveInfo createRemoveCommand()
public byte getPriority()
public void setPriority(byte priority)
public BrokerId[] getBrokerPath()
public void setBrokerPath(BrokerId[] brokerPath)
public BooleanExpression getAdditionalPredicate()
public void setAdditionalPredicate(BooleanExpression additionalPredicate)
public Response visit(CommandVisitor visitor) throws Exception
Exception
public boolean isNetworkSubscription()
public void setNetworkSubscription(boolean networkSubscription)
networkSubscription
- The networkSubscription to set.public boolean isOptimizedAcknowledge()
public void setOptimizedAcknowledge(boolean optimizedAcknowledge)
optimizedAcknowledge
- The optimizedAcknowledge to set.public int getCurrentPrefetchSize()
public void setCurrentPrefetchSize(int currentPrefetchSize)
currentPrefetchSize
- The currentPrefetchSize to set.public boolean isNoRangeAcks()
public void setNoRangeAcks(boolean noRangeAcks)
public void addNetworkConsumerId(ConsumerId networkConsumerId)
public void removeNetworkConsumerId(ConsumerId networkConsumerId)
public boolean isNetworkConsumersEmpty()
public List<ConsumerId> getNetworkConsumerIds()
public ConsumerId[] getNetworkConsumerPath()
public void setNetworkConsumerPath(ConsumerId[] consumerPath)
public void setLastDeliveredSequenceId(long lastDeliveredSequenceId)
public long getLastDeliveredSequenceId()
Copyright © 2005–2017 The Apache Software Foundation. All rights reserved.