com.atomikos.jms
Interface HeuristicMessageConsumer

All Superinterfaces:

MessageConsumer

All Known Subinterfaces:

HeuristicQueueReceiver, HeuristicTopicSubscriber

public interface HeuristicMessageConsumer
extends MessageConsumer

Copyright © 2002-2004, Atomikos. All rights reserved. A message consumer with support for heuristic information. This information is kept in the logs and can help to provide details in case of indoubt or heuristic XA transactions during receive.

Method Summary

Message	receive(HeuristicMessage hmsg) Block until a message is there, but use the supplied heuristic information.
Message	receive(HeuristicMessage hmsg, long timeout) Block until a message is there, but use the supplied heuristic information.
Message	receive(String hmsg) Block until a message is there, and use the supplied heuristic information.
Message	receive(String hmsg, long timeout) Block until a message is there, but use the supplied heuristic information.
Message	receiveNoWait(HeuristicMessage hmsg) Do not block until a message is there, and use the supplied heuristic information.
Message	receiveNoWait(String hmsg) Do not block until a message is there, and use the supplied heuristic information.

Methods inherited from interface javax.jms.MessageConsumer

close, getMessageListener, getMessageSelector, receive, receive, receiveNoWait, setMessageListener

Method Detail

receive

Message receive(HeuristicMessage hmsg)
                throws JMSException

Block until a message is there, but use the supplied heuristic information.

Parameters:

hmsg - The heuristic information to show in case of problems.

Returns:

Message The message.

Throws:

JMSException - On error.

receive

Message receive(String hmsg)
                throws JMSException

Block until a message is there, and use the supplied heuristic information.

Parameters:

hmsg - The heuristic information to show in case of problems.

Returns:

Message The JMS message.

Throws:

JMSException

receive

Message receive(HeuristicMessage hmsg,
                long timeout)
                throws JMSException

Block until a message is there, but use the supplied heuristic information.

Parameters:

hmsg - The heuristic information to show in case of problems.

timeout - The timeout for receive.

Returns:

Message The message or null on timeout.

Throws:

JMSException - On error.

receive

Message receive(String hmsg,
                long timeout)
                throws JMSException

Block until a message is there, but use the supplied heuristic information.

Parameters:

hmsg - The heuristic information to show in case of problems.

timeout - The timeout for receive.

Returns:

Message The message or null on timeout.

Throws:

JMSException - On error.

receiveNoWait

Message receiveNoWait(HeuristicMessage hmsg)
                      throws JMSException

Do not block until a message is there, and use the supplied heuristic information.

Parameters:

hmsg - The heuristic information to show in case of problems.

Returns:

Message The message, or null if none.

Throws:

JMSException - On error.

receiveNoWait

Message receiveNoWait(String hmsg)
                      throws JMSException

Do not block until a message is there, and use the supplied heuristic information.

Parameters:

hmsg - The heuristic information to show in case of problems.

Returns:

Message The message, or null if none.

Throws:

JMSException - On error.