FlowControlledDisposableReadonlyBuffer (AxonServer Connector 4.6.2 API)

java.lang.Object
- io.axoniq.axonserver.connector.impl.buffer.FlowControlledDisposableReadonlyBuffer<T>

Type Parameters:

T - the type of messages this buffer deals with

All Implemented Interfaces:

CloseableReadonlyBuffer<T>, DisposableReadonlyBuffer<T>
```
public class FlowControlledDisposableReadonlyBuffer<T>
extends Object
implements DisposableReadonlyBuffer<T>
```
Connects a FlowControl instance with a DisposableReadonlyBuffer assuming that requesting from the flow control will trigger a replenishment of the buffer.

Since:

4.6.0

Author:

Milan Savic, Stefan Dragisic, Allard Buijze

Constructor Summary

Constructors
Constructor and Description
`FlowControlledDisposableReadonlyBuffer(FlowControl flowControl, CloseableReadonlyBuffer<T> buffer)` Instantiates this buffer with the given `flowControl` and `buffer`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`capacity()` Returns the overall capacity of this buffer.
`boolean`	`closed()` Indicates whether the buffer is closed by the producing side.
`void`	`dispose()` Disposes this buffer from the subscriber's side.
`Optional<ErrorMessage>`	`error()` Returns an error from this buffer, if any.
`boolean`	`isEmpty()` Indicates whether there are messages in the buffer.
`void`	`onAvailable(Runnable onAvailable)` Registers an action to be triggered when there is a new message added to the buffer, or the buffer is closed, or the buffer is closed with an error.
`Optional<T>`	`poll()` Polls the message from this buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FlowControlledDisposableReadonlyBuffer
```
public FlowControlledDisposableReadonlyBuffer(FlowControl flowControl,
                                              CloseableReadonlyBuffer<T> buffer)
```
    Instantiates this buffer with the given flowControl and buffer.
    
    Parameters:
    
    flowControl - used for buffer replenishment
    
    buffer - used for message retrieval on FlowControl.request(long)
- Method Detail
  - poll
```
public Optional<T> poll()
```
    Description copied from interface: CloseableReadonlyBuffer
    
    Polls the message from this buffer. If the returned Optional is empty, that doesn't mean that this buffer stays empty forever. The CloseableReadonlyBuffer.closed() method should be consolidated to validate this.
    
    Specified by:
    
    poll in interface CloseableReadonlyBuffer<T>
    
    Returns:
    
    an Optional with polled message
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: CloseableReadonlyBuffer
    
    Indicates whether there are messages in the buffer. If this returns false, that doesn't mean that this buffer stays empty forever. The CloseableReadonlyBuffer.closed() method should be consolidated to validate this.
    
    Specified by:
    
    isEmpty in interface CloseableReadonlyBuffer<T>
    
    Returns:
    
    true if buffer is empty, false otherwise
  - capacity
```
public int capacity()
```
    Description copied from interface: CloseableReadonlyBuffer
    
    Returns the overall capacity of this buffer.
    
    Specified by:
    
    capacity in interface CloseableReadonlyBuffer<T>
    
    Returns:
    
    the overall capacity of this buffer
  - onAvailable
```
public void onAvailable(Runnable onAvailable)
```
    Description copied from interface: CloseableReadonlyBuffer
    
    Registers an action to be triggered when there is a new message added to the buffer, or the buffer is closed, or the buffer is closed with an error. The action can check CloseableReadonlyBuffer.poll(), CloseableReadonlyBuffer.closed(), and CloseableReadonlyBuffer.error() to validate this.
    
    Specified by:
    
    onAvailable in interface CloseableReadonlyBuffer<T>
    
    Parameters:
    
    onAvailable - to be invoked when there are changes in this buffer
  - dispose
```
public void dispose()
```
    Description copied from interface: DisposableReadonlyBuffer
    
    Disposes this buffer from the subscriber's side.
    
    Specified by:
    
    dispose in interface DisposableReadonlyBuffer<T>
  - closed
```
public boolean closed()
```
    Description copied from interface: CloseableReadonlyBuffer
    
    Indicates whether the buffer is closed by the producing side.
    
    Specified by:
    
    closed in interface CloseableReadonlyBuffer<T>
    
    Returns:
    
    true if closed, false otherwise
  - error
```
public Optional<ErrorMessage> error()
```
    Description copied from interface: CloseableReadonlyBuffer
    
    Returns an error from this buffer, if any.
    
    Specified by:
    
    error in interface CloseableReadonlyBuffer<T>
    
    Returns:
    
    an Optional of an error, if any

Class FlowControlledDisposableReadonlyBuffer<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowControlledDisposableReadonlyBuffer

Method Detail

poll

isEmpty

capacity

onAvailable

dispose

closed

error