Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.protocol
Interface Receiver

All Known Subinterfaces:
InputChannel, MessageReceiver, MessageReceiverSupport, Protocol, ReceiverSupport, RequestReceiver, RequestReceiverSupport
All Known Implementing Classes:
AbstractQueueReceiver, ClientChannel, DuplexChannel, QueueMessageReceiver, QueueRequestReceiver, ServerChannel

public interface Receiver


Field Summary
static int DEF_INPUT_SIZE
           
 
Method Summary
 void clearInput()
          Clears input of the receiver.
 int getInputSize()
          Return the amount of messages this Receiver can hold before start to "forget stale messages"
 void releaseReceivers()
          Notify receivers (threads waiting on receive() methods) they should stop waiting and return null.
 void setInputSize(int inputSize)
          Set the amount of messages this Receiver can hold before start to "forget stale messages"
 

Field Detail

DEF_INPUT_SIZE

public static final int DEF_INPUT_SIZE
See Also:
Constant Field Values
Method Detail

clearInput

public void clearInput()
Clears input of the receiver. Please note, that there is no strict guaranties that input will be empty after this method has returned, the messages could be delivered by another thread.


getInputSize

public int getInputSize()
Return the amount of messages this Receiver can hold before start to "forget stale messages"

Returns:
maximum count of messages stored in receiver

setInputSize

public void setInputSize(int inputSize)
Set the amount of messages this Receiver can hold before start to "forget stale messages"

Parameters:
inputSize - maximum count of messages stored in receiver

releaseReceivers

public void releaseReceivers()
Notify receivers (threads waiting on receive() methods) they should stop waiting and return null.


Configuration Platform SDK 7.6 API Reference

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