Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Interface MessageReceiver

All Superinterfaces:
Receiver
All Known Subinterfaces:
InputChannel, MessageReceiverSupport, Protocol
All Known Implementing Classes:
ClientChannel, DuplexChannel, QueueMessageReceiver

public interface MessageReceiver
extends Receiver


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

Method Detail

receive

public Message receive()
                throws java.lang.InterruptedException,
                       java.lang.IllegalStateException
Receive 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

receive

public Message receive(long timeout)
                throws java.lang.InterruptedException,
                       java.lang.IllegalStateException
Receive 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

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.