net.openhft.chronicle.wire

Interface HeadNumberChecker

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 HeadNumberChecker

Represents a functional interface for checking header numbers against specific criteria.

This interface provides a contract for checking a given header number and its position. Typically, implementations of this interface will contain logic to determine whether the provided header number, in the context of its position are a valid combination.

Used by AbstractWire to validate header numbers, for example, to ensure sequence numbers are contiguous or monotonically increasing when reading from a queue.

Method Summary

Modifier and Type	Method and Description
boolean	checkHeaderNumber(long headerNumber, long position) Checks whether the provided header number meets a certain condition in the context of its position.

Method Detail

checkHeaderNumber

boolean checkHeaderNumber(long headerNumber,
                          long position)

Checks whether the provided header number meets a certain condition in the context of its position.

Parameters:

headerNumber - The header number read from the wire.

position - The byte position in the wire where this header number was encountered. This can be used for context or logging.

Returns:

true if the header number is considered valid according to the implementation's logic, false otherwise (which might lead to an error or retry).