com.graphhopper.storage

Class MMapDataAccess

java.lang.Object

com.graphhopper.storage.AbstractDataAccess

com.graphhopper.storage.MMapDataAccess

All Implemented Interfaces:

DataAccess, Storable<DataAccess>, Closeable, AutoCloseable

public final class MMapDataAccess
extends AbstractDataAccess

A DataAccess implementation using a memory-mapped file, i.e. a facility of the operating system to access a file like an area of RAM.

Java presents the mapped memory as a ByteBuffer, and ByteBuffer is not thread-safe, which means that access to a ByteBuffer must be externally synchronized.

This class itself is intended to be as thread-safe as other DataAccess implementations are.

The exact behavior of memory-mapping is reported to be wildly platform-dependent.

Author:

Peter Karich, Michael Zilske

Field Summary

Fields inherited from class com.graphhopper.storage.AbstractDataAccess

bitUtil, byteOrder, closed, EMPTY, header, HEADER_OFFSET, indexDivisor, name, SEGMENT_SIZE_MIN, segmentSizeInBytes, segmentSizePower

Method Summary

Modifier and Type	Method and Description
static void	cleanMappedByteBuffer(ByteBuffer buffer)
void	close() This method makes sure that the underlying used resources are released.
DataAccess	copyTo(DataAccess da) Copies the content from this object into the specified one.
MMapDataAccess	create(long bytes) The first time you use a DataAccess object after configuring it you need to call this method.
boolean	ensureCapacity(long bytes) Ensures that the capacity of this object is at least the specified bytes.
void	flush() This method makes sure that the underlying data is written to the storage.
byte	getByte(long bytePos)
void	getBytes(long bytePos, byte[] values, int length) Get bytes from position 'index'
long	getCapacity()
int	getInt(long bytePos) Get 4 bytes from position 'bytePos'
int	getSegments()
short	getShort(long bytePos) Get 2 bytes from position 'index'
DAType	getType()
static boolean	jreIsMinimumJava9()
boolean	loadExisting()
void	rename(String newName) Renames the underlying DataAccess object.
void	setByte(long bytePos, byte value)
void	setBytes(long bytePos, byte[] values, int length) Set bytes from position 'index' to the specified values
void	setInt(long bytePos, int value) Set 4 bytes at position 'bytePos' to the specified value
void	setShort(long bytePos, short value) Set 2 bytes at position 'index' to the specified value
void	trimTo(long capacity) Reduces the allocate space to the specified bytes.

Methods inherited from class com.graphhopper.storage.AbstractDataAccess

checkBeforeRename, copyHeader, getFullName, getHeader, getName, getSegmentSize, isClosed, isIntBased, isStoring, readHeader, setHeader, setSegmentSize, toString, writeHeader

Methods inherited from class java.lang.Object

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

Method Detail

jreIsMinimumJava9

public static boolean jreIsMinimumJava9()

cleanMappedByteBuffer

public static void cleanMappedByteBuffer(ByteBuffer buffer)

create

public MMapDataAccess create(long bytes)

Description copied from interface: DataAccess

The first time you use a DataAccess object after configuring it you need to call this method. After that first call you have to use ensureCapacity to ensure that enough space is reserved.

copyTo

public DataAccess copyTo(DataAccess da)

Description copied from interface: DataAccess

Copies the content from this object into the specified one.

Specified by:

copyTo in interface DataAccess

Overrides:

copyTo in class AbstractDataAccess

ensureCapacity

public boolean ensureCapacity(long bytes)

Description copied from interface: DataAccess

Ensures that the capacity of this object is at least the specified bytes. The first time you have to call 'create' instead.

Returns:

true if size was increased

See Also:

DataAccess.create(long)

loadExisting

public boolean loadExisting()

Returns:

true if successfully loaded from persistent storage.

flush

public void flush()

Description copied from interface: Storable

This method makes sure that the underlying data is written to the storage. Keep in mind that a disc normally has an IO cache so that flush() is (less) probably not save against power loses.

close

public void close()

Description copied from interface: Storable

This method makes sure that the underlying used resources are released. WARNING: it does NOT flush on close!

Specified by:

close in interface Storable<DataAccess>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractDataAccess

setInt

public final void setInt(long bytePos,
                         int value)

Description copied from interface: DataAccess

Set 4 bytes at position 'bytePos' to the specified value

getInt

public final int getInt(long bytePos)

Description copied from interface: DataAccess

Get 4 bytes from position 'bytePos'

setShort

public final void setShort(long bytePos,
                           short value)

Description copied from interface: DataAccess

Set 2 bytes at position 'index' to the specified value

getShort

public final short getShort(long bytePos)

Description copied from interface: DataAccess

Get 2 bytes from position 'index'

setBytes

public void setBytes(long bytePos,
                     byte[] values,
                     int length)

Description copied from interface: DataAccess

Set bytes from position 'index' to the specified values

getBytes

public void getBytes(long bytePos,
                     byte[] values,
                     int length)

Description copied from interface: DataAccess

Get bytes from position 'index'

values - acts as output

setByte

public void setByte(long bytePos,
                    byte value)

getByte

public byte getByte(long bytePos)

getCapacity

public long getCapacity()

Returns:

the allocated storage size in bytes

getSegments

public int getSegments()

Returns:

the number of segments.

trimTo

public void trimTo(long capacity)

Description copied from interface: DataAccess

Reduces the allocate space to the specified bytes. Warning: it'll free the space even if it is in use!

rename

public void rename(String newName)

Description copied from interface: DataAccess

Renames the underlying DataAccess object. (Flushing shouldn't be necessary before or afterwards)

Specified by:

rename in interface DataAccess

Overrides:

rename in class AbstractDataAccess

getType

public DAType getType()

Returns:

the data access type of this object.