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

Type Parameters:

T - the type of messages in this buffer

All Implemented Interfaces:

CloseableBuffer<T>, CloseableReadonlyBuffer<T>
```
public class BlockingCloseableBuffer<T>
extends Object
implements CloseableBuffer<T>
```
An implementation of the CloseableBuffer that uses a LinkedBlockingQueue as the backing buffer.

Since:

4.6.0

Author:

Milan Savic, Stefan Dragisic, Allard Buijze

Constructor Summary

Constructors
Constructor Description

BlockingCloseableBuffer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`capacity()`	Returns the overall capacity of this buffer.
`void`	`close()`	Closes this buffer from the producing side.
`boolean`	`closed()`	Indicates whether the buffer is closed by the producing side.
`void`	`closeExceptionally(ErrorMessage errorMessage)`	Closes this buffer exceptionally from the producing side.
`Optional<ErrorMessage>`	`error()`	Returns an error from this buffer, if any.
`boolean`	`isEmpty()`	Indicates whether there are messages in the buffer.
`protected void`	`notifyOnAvailable()`
`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.
`void`	`put(T message)`	Puts a message in this buffer.
`int`	`size()`	Returns the number of elements in this buffer.

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

- Constructor Detail
  - BlockingCloseableBuffer
```
public BlockingCloseableBuffer()
```
- 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
  - size
```
public int size()
```
    Returns the number of elements in this buffer.
    
    Returns:
    
    the number of elements in 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
  - put
```
public void put(T message)
```
    Description copied from interface: CloseableBuffer
    
    Puts a message in this buffer.
    
    Specified by:
    
    put in interface CloseableBuffer<T>
    
    Parameters:
    
    message - the message to be put in this buffer
  - 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
  - close
```
public void close()
```
    Description copied from interface: CloseableBuffer
    
    Closes this buffer from the producing side.
    
    Specified by:
    
    close in interface CloseableBuffer<T>
  - closeExceptionally
```
public void closeExceptionally(ErrorMessage errorMessage)
```
    Description copied from interface: CloseableBuffer
    
    Closes this buffer exceptionally from the producing side.
    
    Specified by:
    
    closeExceptionally in interface CloseableBuffer<T>
    
    Parameters:
    
    errorMessage - an error indicating why this buffer is closed
  - notifyOnAvailable
```
protected void notifyOnAvailable()
```

Class BlockingCloseableBuffer<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BlockingCloseableBuffer

Method Detail

poll

isEmpty

capacity

size

onAvailable

put

closed

error

close

closeExceptionally

notifyOnAvailable