net.openhft.chronicle.bytes

Interface BytesConsumer

All Known Subinterfaces:

BytesRingBuffer, MultiReaderBytesRingBuffer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface BytesConsumer

A functional interface for consuming bytes. The interface defines a single method read for retrieving and removing the head of a queue into a given BytesOut object.

Method Summary

Modifier and Type	Method and Description
boolean	read(BytesOut<?> bytes) Retrieves and removes the head of this queue, or returns false if this queue is empty.

Method Detail

read

boolean read(BytesOut<?> bytes)
      throws BufferOverflowException

Retrieves and removes the head of this queue, or returns false if this queue is empty.

Parameters:

bytes - the BytesOut object to read into.

Returns:

false if this queue is empty, true otherwise.

Throws:

BufferOverflowException - if there is insufficient space left in the buffer.