org.springframework.messaging.core

Class GenericMessagingTemplate.TemporaryReplyChannel

java.lang.Object

org.springframework.messaging.core.GenericMessagingTemplate.TemporaryReplyChannel

All Implemented Interfaces:

MessageChannel, PollableChannel

Enclosing class:

GenericMessagingTemplate

private class GenericMessagingTemplate.TemporaryReplyChannel
extends java.lang.Object
implements PollableChannel

A temporary channel for receiving a single reply message.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	hasReceived
private boolean	hasSendFailed
private boolean	hasTimedOut
private Log	logger
private java.util.concurrent.CountDownLatch	replyLatch
private Message<?>	replyMessage

Fields inherited from interface org.springframework.messaging.MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TemporaryReplyChannel()

Method Summary

Modifier and Type	Method and Description
Message<?>	receive() Receive a message from this channel, blocking indefinitely if necessary.
Message<?>	receive(long timeout) Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.
boolean	send(Message<?> message) Send a Message to this channel.
boolean	send(Message<?> message, long timeout) Send a message, blocking until either the message is accepted or the specified timeout period elapses.
void	setSendFailed(boolean hasSendError)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private final Log logger

replyLatch

private final java.util.concurrent.CountDownLatch replyLatch

replyMessage

private volatile Message<?> replyMessage

hasReceived

private volatile boolean hasReceived

hasTimedOut

private volatile boolean hasTimedOut

hasSendFailed

private volatile boolean hasSendFailed

Constructor Detail

TemporaryReplyChannel

private TemporaryReplyChannel()

Method Detail

setSendFailed

public void setSendFailed(boolean hasSendError)

receive

public Message<?> receive()

Description copied from interface: PollableChannel

Receive a message from this channel, blocking indefinitely if necessary.

Specified by:

receive in interface PollableChannel

Returns:

the next available Message or null if interrupted

receive

public Message<?> receive(long timeout)

Description copied from interface: PollableChannel

Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.

Specified by:

receive in interface PollableChannel

Parameters:

timeout - the timeout in milliseconds or MessageChannel.INDEFINITE_TIMEOUT.

Returns:

the next available Message or null if the specified timeout period elapses or the message reception is interrupted

send

public boolean send(Message<?> message)

Description copied from interface: MessageChannel

Send a Message to this channel. If the message is sent successfully, the method returns true. If the message cannot be sent due to a non-fatal reason, the method returns false. The method may also throw a RuntimeException in case of non-recoverable errors.

This method may block indefinitely, depending on the implementation. To provide a maximum wait time, use MessageChannel.send(Message, long).

Specified by:

send in interface MessageChannel

Parameters:

message - the message to send

Returns:

whether or not the message was sent

send

public boolean send(Message<?> message,
                    long timeout)

Description copied from interface: MessageChannel

Send a message, blocking until either the message is accepted or the specified timeout period elapses.

Specified by:

send in interface MessageChannel

Parameters:

message - the message to send

timeout - the timeout in milliseconds or MessageChannel.INDEFINITE_TIMEOUT

Returns:

true if the message is sent, false if not including a timeout of an interrupt of the send