io.atomix.storage.buffer

Class MappedBytes

java.lang.Object

io.atomix.storage.buffer.AbstractBytes

io.atomix.storage.buffer.ByteBufferBytes

io.atomix.storage.buffer.MappedBytes

All Implemented Interfaces:

Bytes, BytesInput<Bytes>, BytesOutput<Bytes>, AutoCloseable

public class MappedBytes
extends ByteBufferBytes

ByteBuffer based mapped bytes.

Field Summary

Fields inherited from interface io.atomix.storage.buffer.Bytes

BOOLEAN, BYTE, CHARACTER, DOUBLE, FLOAT, INTEGER, LONG, MEDIUM, SHORT

Method Summary

Modifier and Type	Method and Description
static MappedBytes	allocate(File file, FileChannel.MapMode mode, int size) Allocates a mapped buffer.
static MappedBytes	allocate(File file, int size) Allocates a mapped buffer in FileChannel.MapMode#READ_WRITE mode.
void	close()
void	delete() Deletes the underlying file.
Bytes	flush() Flushes the bytes to the underlying persistence layer.
boolean	isDirect() Returns a boolean value indicating whether the bytes are direct.

Methods inherited from class io.atomix.storage.buffer.ByteBufferBytes

array, byteBuffer, order, order, read, read, readByte, readChar, readDouble, readFloat, readInt, readLong, readShort, reset, resize, size, write, write, writeByte, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeShort, zero, zero, zero

Methods inherited from class io.atomix.storage.buffer.AbstractBytes

isFile, readBoolean, readMedium, readString, readString, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, readUTF8, writeBoolean, writeMedium, writeString, writeString, writeUnsignedByte, writeUnsignedInt, writeUnsignedMedium, writeUnsignedShort, writeUTF8

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.atomix.storage.buffer.Bytes

hasArray

Method Detail

allocate

public static MappedBytes allocate(File file,
                                   int size)

Allocates a mapped buffer in FileChannel.MapMode#READ_WRITE mode.

Memory will be mapped by opening and expanding the given File to the desired count and mapping the file contents into memory via FileChannel.map(FileChannel.MapMode, long, long).

Parameters:

file - The file to map into memory. If the file doesn't exist it will be automatically created.

size - The count of the buffer to allocate (in bytes).

Returns:

The mapped buffer.

Throws:

NullPointerException - If file is null

IllegalArgumentException - If count is greater than MappedMemory.MAX_SIZE

See Also:

allocate(File, FileChannel.MapMode, int)

allocate

public static MappedBytes allocate(File file,
                                   FileChannel.MapMode mode,
                                   int size)

Allocates a mapped buffer.

Memory will be mapped by opening and expanding the given File to the desired count and mapping the file contents into memory via FileChannel.map(FileChannel.MapMode, long, long).

Parameters:

file - The file to map into memory. If the file doesn't exist it will be automatically created.

mode - The mode with which to map the file.

size - The count of the buffer to allocate (in bytes).

Returns:

The mapped buffer.

Throws:

NullPointerException - If file is null

IllegalArgumentException - If count is greater than Integer.MAX_VALUE

See Also:

allocate(File, int)

isDirect

public boolean isDirect()

Description copied from interface: Bytes

Returns a boolean value indicating whether the bytes are direct.

Specified by:

isDirect in interface Bytes

Overrides:

isDirect in class AbstractBytes

Returns:

Indicates whether the bytes are direct.

flush

public Bytes flush()

Description copied from interface: BytesOutput

Flushes the bytes to the underlying persistence layer.

Specified by:

flush in interface BytesOutput<Bytes>

Overrides:

flush in class AbstractBytes

Returns:

The flushed buffer.

close

public void close()

Specified by:

close in interface Bytes

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractBytes

delete

public void delete()

Deletes the underlying file.