Package org.agrona.agent

Class BufferAlignmentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.agrona.agent.BufferAlignmentException

All Implemented Interfaces:

Serializable

public class BufferAlignmentException
extends RuntimeException

Runtime Exception thrown by BufferAlignmentAgent when an unaligned memory access is detected.

Package-protected to discourage catching since this as agent should be used only for testing and debugging.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BufferAlignmentException(String prefix, int index, long addressOffset)	Create exception with details about the unaligned access.

Method Summary

Modifier and Type	Method	Description
long	addressOffset()	Returns an address offset into the start of the underlying buffer.
int	index()	Returns an index at which unaligned access occurred.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BufferAlignmentException

public BufferAlignmentException(String prefix,
 int index,
 long addressOffset)

Create exception with details about the unaligned access.

Parameters:

prefix - for the error message.

index - at which the unaligned access occurred.

addressOffset - pointing to the beginning of the underlying buffer.

Method Details

index

public int index()

Returns an index at which unaligned access occurred.

Returns:

index.

addressOffset

public long addressOffset()

Returns an address offset into the start of the underlying buffer.

Returns:

address of the beginning of the underlying buffer.