Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol
Interface MessageReceiver<T>

All Superinterfaces:
Receiver
All Known Subinterfaces:
ClusterProtocol, InputChannel, MessageReceiverSupport, Protocol
All Known Implementing Classes:
AbstractClusterChannel, BasicChatProtocol, CallbackClientChannelHandler, CallbackProtocol, ChatClientChannelHandler, ClientChannel, ClientChannelHandler, ClusterProtocolImpl, ConfServerClientChannelHandler, ConfServerProtocol, DuplexChannel, EmailClientChannelHandler, EmailProtocol, EspClusterProtocol, EspEmailClientChannelHandler, EspEmailClusterProtocol, EspEmailProtocol, EventReceivingBrokerService, ExternalServiceClientChannelHandler, ExternalServiceProtocol, FlexChatClusterProtocol, FlexChatProtocol, IgnoringMessageReceiverSupport, InteractionServerClientChannelHandler, InteractionServerProtocol, LcaUdpHeartbeatInternalProtocol, LocalControlAgentProtocol, MessageServerProtocol, OptionalRegistrationChannel, OutboundServerProtocol, QueueMessageReceiver, RoutingServerProtocol, SolutionControlServerProtocol, StatServerProtocol, TServerProtocol, UcsClusterProtocol, UniversalContactServerClientChannelHandler, UniversalContactServerProtocol, UrsCustomProtocol, WebmediaChannel, WebMediaClientChannelHandler

public interface MessageReceiver<T>
extends Receiver

Message receiver is going to be deprecated.

See Also:
MessageHandler, DuplexChannel.setMessageHandler(MessageHandler)

Field Summary
 
Fields inherited from interface com.genesyslab.platform.commons.protocol.Receiver
DEF_INPUT_SIZE
 
Method Summary
 T receive()
          Receives message from the channel.
 T receive(long timeout)
          Receives message from the channel.
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Receiver
clearInput, getInputSize, releaseReceivers, setInputSize
 

Method Detail

receive

T receive()
          throws java.lang.InterruptedException,
                 java.lang.IllegalStateException
Receives message from the channel. Depending on implementation this method will or won't block for some or infinite time.

Returns:
Message from the channel or null if the channel is "empty"
Throws:
java.lang.InterruptedException - if thread is interrupted during this method execution
java.lang.IllegalStateException - if channel is not in appropriate state to call the method
See Also:
MessageHandler, DuplexChannel.setMessageHandler(MessageHandler)

receive

T receive(long timeout)
          throws java.lang.InterruptedException,
                 java.lang.IllegalStateException
Receives message from the channel. Depending on timeout value this method will or won't block for some time. See Channel description for timeout values meaning.

Parameters:
timeout - timeout to waitResponse for message
Returns:
Message from the channel or null if the channel is "empty"
Throws:
java.lang.InterruptedException - if thread is interrupted during this method execution
java.lang.IllegalStateException - if channel is not in appropriate state to call the method
See Also:
MessageHandler, DuplexChannel.setMessageHandler(MessageHandler)

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.