BinaryStoreReader

All Known Subinterfaces:: BinaryStoreBufferProcessor

All Known Implementing Classes:: AbstractBinaryStoreReader, AbstractBinaryStoreReaderV1, AbstractBinaryStoreReaderV2, BinaryStoreBufferProcessorV1, BinaryStoreBufferProcessorV2, BinaryStoreReaderV1, BinaryStoreReaderV2, BinaryStoreSocketReaderV2, DelegatingBinaryStoreV2BufferProcessor

public interface BinaryStoreReader

Interface for functionality common between BinaryStoreBufferProcessor and the Binary Store Readers.

Method Summary

Modifier and Type Method Description

void readHeader(ByteBuffer byteBuffer)
Read a binary header from the given buffer.

Method Details
- readHeader
  
  void readHeader(ByteBuffer byteBuffer) throws IOException, EofException
  
  Read a binary header from the given buffer. This interface does not dictate anything about the BinaryStore implementation in the buffer. Implementations might make implementation-dependent actions to fill the buffer if there isn't enough data. byteBuffer.position will be advanced by the size of the header.
  
  Parameters:
  
  byteBuffer - buffer containing the header, in reading mode
  
  Throws:
  
  IOException - an exception derived from IOException may be thrown if there isn't enough data in the buffer.
  
  EofException - may be thrown if an underlying channel (if any) ends.