immutant.messaging.hornetq — ikitommi/immutant-messaging 3.0.0-alpha3

Utilities specific to HornetQ

destination-controller clj

(destination-controller destination)

(destination-controller destination control-type)

Returns the destination controller for destination.

destination should be the result of calling immutant.messaging/queue or immutant.messaging/topic.

The returned controller depends on the type of the given destination and, for queues, the requested control-type (which defaults to :jms):

Destination Type	Control Type	Controller Type
queue	:jms	JMSQueueControl
queue	:core	QueueControl
topic	N/A	TopicControl

Refer to the javadocs for those control classes for details on the available operations.

server-manager clj

(server-manager)

Retrieves the local JMS server manager instance.

set-address-options clj

(set-address-options match settings)

Sets the HornetQ-specific address options for the given match.

This provides programatic access to options that are normally set in the xml configuration. match must be either a destination returned from immutant.messaging/queue or immutant.messaging/topic, or a fully qualified jms destination name (prefixed with 'jms.queue.' or 'jms.topic.'). It may contain HornetQ wildcard matchers (see http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/wildcard-syntax.html).

The following settings are supported [default value]:

• :address-full-message-policy [:page] - Specifies what should happen when an address reaches :max-size-bytes in undelivered messages. Options are:

  • :block - publish calls will block until the current size drops below :max-size-bytes
  • :drop - new messages are silently dropped
  • :fail - new messages are dropped and an exception is thrown on publish
  • :page - new messages will be paged to disk See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/paging.html

• :dead-letter-address [jms.queue.DLQ] - If set, any messages that fail to deliver to their original destination will be delivered here. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/undelivered-messages.html#undelivered-messages.configuring

• :expiry-address [jms.queue.ExpiryQueue] - If set, any messages with a :ttl that expires before delivery will be delivered here. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/message-expiry.html#message-expiry.configuring

• :expiry-delay [-1] - If > -1, this value (in millis) is used as the default :ttl for messages that don't have a :ttl > 0 set.

• :last-value-queue [false] - If true, only the most recent message for a last-value property will be retained. Setting this option will also cause :address-full-message-policy to be set to :drop, as HornetQ has a bug related to paging last value queues. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/last-value-queues.html

• :max-delivery-attempts [10] - The number of times delivery will be attempted for a message before giving up. If :dead-letter-address is set, the message will be delivered there, or removed otherwise. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/undelivered-messages.html#undelivered-messages.configuring

• :max-redelivery-delay [:redelivery-delay] - Specifies the maximum redelivery delay (in millis) when a :redelivery-multiplier is used.

• :max-size-bytes [20971520 (20MB)] - The maximum size (in bytes) of retained messages on an address before :address-full-message-policy is applied. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/paging.html

• :page-cache-max-size [5] - HornetQ will keep up to this many page files in memory to optimize IO. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/paging.html

• :page-size-bytes [10485760 (10MB)] - The size (in bytes) of the page files created when paging. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/paging.html

• :redelivery-delay [0] - Specifies the delay (in millis) between redelivery attempts. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/undelivered-messages.html#undelivered-messages.delay

• :redelivery-multiplier [1.0] - Controls the backoff for redeliveries. The delay between redelivery attempts is calculated as :redelivery-delay * (:redelivery-multiplier ^ attempt-count). This won't have any effect if you don't also set :redelivery-delay and :max-redelivery-delay.

• :redistribution-delay [1000] - Specifies the delay (in millis) to wait before redistributing messages from a node in a cluster to other nodes when the queue no longer has consumers on the current node. See http://docs.jboss.org/hornetq/2.3.0.Final/docs/user-manual/html/clusters.html

• :send-to-dla-on-no-route [false] - If true, any message that can't be routed to its destination will be sent to :dead-letter-address.

Calling this function again with the same match will override replace any previous settings for that match.