BufferedRatInput (adams-addons-pom 24.12.0-SNAPSHOT API)

All Superinterfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.option.OptionHandler, RatInput, adams.core.Stoppable, adams.core.StoppableWithFeedback

All Known Implementing Classes:

AbstractBufferedRatInput, RedisSubscribe, RESTTextReception, Socket, Subscribe, WebserviceInput, WSBlobReception, WSTextReception
```
public interface BufferedRatInput
extends RatInput
```
Interface for RatInput schemes that buffer incoming data.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`bufferData(Object value)`	For buffering data.
`int`	`getMaxBuffer()`	Returns the maximum number of items to buffer.
`String`	`maxBufferTipText()`	Returns the tip text for this property.
`void`	`setMaxBuffer(int value)`	Sets the maximum number of items to buffer.

Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.standalone.rats.input.RatInput
generates, getFullName, getOwner, getReceptionInterrupted, hasPendingOutput, initReception, interruptReception, isReceptionRunning, isStopped, output, receive, setOwner, setUp, stopExecution

- Method Detail
  - setMaxBuffer
```
void setMaxBuffer(int value)
```
    Sets the maximum number of items to buffer.
    
    Parameters:
    
    value - the maximum number of items to buffer
  - getMaxBuffer
```
int getMaxBuffer()
```
    Returns the maximum number of items to buffer.
    
    Returns:
    
    the maximum number of items to buffer
  - maxBufferTipText
```
String maxBufferTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - bufferData
```
void bufferData(Object value)
```
    For buffering data.
    
    Parameters:
    
    value - the data to buffer