activemq::connector::stomp::commands::SubscribeCommand Class Reference

#include <SubscribeCommand.h>

Inheritance diagram for activemq::connector::stomp::commands::SubscribeCommand:

List of all members.

Public Member Functions
	SubscribeCommand (void)
	SubscribeCommand (StompFrame *frame)
virtual	~SubscribeCommand (void)
virtual const char *	getDestination (void) const
virtual void	setDestination (const std::string &destination)
virtual void	setAckMode (const CommandConstants::AckMode mode)
virtual CommandConstants::AckMode	getAckMode (void) const
virtual void	setMessageSelector (const std::string &selector)
virtual const char *	getMessageSelector (void) const
virtual void	setSubscriptionName (const std::string &name)
virtual const char *	getSubscriptionName (void) const
virtual bool	getNoLocal (void) const
virtual void	setNoLocal (bool noLocal)
virtual bool	getDispatchAsync (void) const
virtual void	setDispatchAsync (bool dispatchAsync)
virtual bool	getExclusive (void) const
virtual void	setExclusive (bool exclusive)
virtual int	getMaxPendingMsgLimit (void) const
virtual void	setMaxPendingMsgLimit (int limit)
virtual int	getPrefetchSize (void) const
virtual void	setPrefetchSize (int size)
virtual int	getPriority (void) const
virtual void	setPriority (int priority)
virtual bool	getRetroactive (void) const
virtual void	setRetroactive (bool retroactive)
Protected Member Functions
virtual void	initialize (StompFrame &frame)
virtual bool	validate (const StompFrame &frame) const

---

Detailed Description

Command sent to the broker to subscribe to a topic or queue.

---

Constructor & Destructor Documentation

activemq::connector::stomp::commands::SubscribeCommand::SubscribeCommand (  void   )  [inline]

activemq::connector::stomp::commands::SubscribeCommand::SubscribeCommand (  StompFrame *  frame  )  [inline]

virtual activemq::connector::stomp::commands::SubscribeCommand::~SubscribeCommand (  void   )  [inline, virtual]

---

Member Function Documentation

virtual CommandConstants::AckMode activemq::connector::stomp::commands::SubscribeCommand::getAckMode (  void   )  const [inline, virtual]

Get the Ack Mode of this Subscription Returns: mode setting.

virtual const char* activemq::connector::stomp::commands::SubscribeCommand::getDestination (  void   )  const [inline, virtual]

Get the destination Returns: the destination Name String

virtual bool activemq::connector::stomp::commands::SubscribeCommand::getDispatchAsync (  void   )  const [inline, virtual]

Sets whether or not the broker is to dispatch messages in an asynchronous manner. Set to true if you want Async. Returns: true if in dispatch async mode

virtual bool activemq::connector::stomp::commands::SubscribeCommand::getExclusive (  void   )  const [inline, virtual]

Gets whether or not this consumer is an exclusive consumer for this destination. Returns: true for exclusive mode

virtual int activemq::connector::stomp::commands::SubscribeCommand::getMaxPendingMsgLimit (  void   )  const [inline, virtual]

Get the max number of pending messages on a destination For Slow Consumer Handlingon non-durable topics by dropping old messages - we can set a maximum pending limit which once a slow consumer backs up to this high water mark we begin to discard old messages Returns: Max value

virtual const char* activemq::connector::stomp::commands::SubscribeCommand::getMessageSelector (  void   )  const [inline, virtual]

Gets the Message Selector that is associated with this subscribe request Returns: the selector string

virtual bool activemq::connector::stomp::commands::SubscribeCommand::getNoLocal (  void   )  const [inline, virtual]

Gets whether or not locally sent messages should be ignored for subscriptions. Set to true to filter out locally sent messages Returns: NoLocal value

virtual int activemq::connector::stomp::commands::SubscribeCommand::getPrefetchSize (  void   )  const [inline, virtual]

Get the maximum number of pending messages that will be dispatched to the client. Once this maximum is reached no more messages are dispatched until the client acknowledges a message. Set to 1 for very fair distribution of messages across consumers where processing messages can be slow Returns: prefetch size value

virtual int activemq::connector::stomp::commands::SubscribeCommand::getPriority (  void   )  const [inline, virtual]

Gets the priority of the consumer so that dispatching can be weighted in priority order Returns: priority level

virtual bool activemq::connector::stomp::commands::SubscribeCommand::getRetroactive (  void   )  const [inline, virtual]

Get For non-durable topics if this subscription is set to be retroactive Returns: true for retroactive mode

virtual const char* activemq::connector::stomp::commands::SubscribeCommand::getSubscriptionName (  void   )  const [inline, virtual]

Gets the Subscription Name that is associated with this subscribe request Returns: the Subscription Name

virtual void activemq::connector::stomp::commands::SubscribeCommand::initialize (  StompFrame &  frame  )  [inline, protected, virtual]

Inheritors are required to override this method to init the frame with data appropriate for the command type. Parameters: frame  Frame to init Implements activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

virtual void activemq::connector::stomp::commands::SubscribeCommand::setAckMode (  const CommandConstants::AckMode  mode  )  [inline, virtual]

Set the Ack Mode of this Subscription Parameters: mode  Ack mode setting.

virtual void activemq::connector::stomp::commands::SubscribeCommand::setDestination (  const std::string &  destination  )  [inline, virtual]

Set the destination Parameters: destination  the destination Name String

virtual void activemq::connector::stomp::commands::SubscribeCommand::setDispatchAsync (  bool  dispatchAsync  )  [inline, virtual]

Sets whether or not the broker is to dispatch messages in an asynchronous manner. Set to true if you want Async. Parameters: dispatchAsync  true for async dispatch mode

virtual void activemq::connector::stomp::commands::SubscribeCommand::setExclusive (  bool  exclusive  )  [inline, virtual]

Sets whether or not this consumer is an exclusive consumer for this destination. Parameters: exclusive  true if in exclusive mode

virtual void activemq::connector::stomp::commands::SubscribeCommand::setMaxPendingMsgLimit (  int  limit  )  [inline, virtual]

Set the max number of pending messages on a destination For Slow Consumer Handlingon non-durable topics by dropping old messages - we can set a maximum pending limit which once a slow consumer backs up to this high water mark we begin to discard old messages Parameters: limit  Max Pending value

virtual void activemq::connector::stomp::commands::SubscribeCommand::setMessageSelector (  const std::string &  selector  )  [inline, virtual]

Sets the Message Selector that is associated with this subscribe request Parameters: selector  Destination selector string

virtual void activemq::connector::stomp::commands::SubscribeCommand::setNoLocal (  bool  noLocal  )  [inline, virtual]

Sets whether or not locally sent messages should be ignored for subscriptions. Set to true to filter out locally sent messages Parameters: noLocal  No Local delivery value

virtual void activemq::connector::stomp::commands::SubscribeCommand::setPrefetchSize (  int  size  )  [inline, virtual]

Set the maximum number of pending messages that will be dispatched to the client. Once this maximum is reached no more messages are dispatched until the client acknowledges a message. Set to 1 for very fair distribution of messages across consumers where processing messages can be slow Parameters: size  prefetch size value

virtual void activemq::connector::stomp::commands::SubscribeCommand::setPriority (  int  priority  )  [inline, virtual]

Sets the priority of the consumer so that dispatching can be weighted in priority order Parameters: priority  message prioirty level

virtual void activemq::connector::stomp::commands::SubscribeCommand::setRetroactive (  bool  retroactive  )  [inline, virtual]

Set For non-durable topics if this subscription is set to be retroactive Parameters: retroactive  true if in retroactive mode

virtual void activemq::connector::stomp::commands::SubscribeCommand::setSubscriptionName (  const std::string &  name  )  [inline, virtual]

Sets the Subscription Name that is associated with this subscribe request Parameters: name  Subscription Name

virtual bool activemq::connector::stomp::commands::SubscribeCommand::validate (  const StompFrame &  frame  )  const [inline, protected, virtual]

Inheritors are required to override this method to validate the passed stomp frame before it is marshalled or unmarshaled Parameters: frame  Frame to validate Returns: frame true if frame is valid Implements activemq::connector::stomp::commands::AbstractCommand< transport::Command >.

---

The documentation for this class was generated from the following file:

• activemq-cpp/src/main/activemq/connector/stomp/commands/SubscribeCommand.h

---