net.openhft.lang.io

Class MappedMemory

java.lang.Object

net.openhft.lang.io.MappedMemory

All Implemented Interfaces:

BytesStore, ReferenceCounted

public class MappedMemory
extends Object
implements ReferenceCounted, BytesStore

Constructor Summary

Constructors

Constructor and Description
MappedMemory(MappedByteBuffer buffer, long index)

Method Summary

Methods

Modifier and Type	Method and Description
long	address()
MappedByteBuffer	buffer()
Bytes	bytes() Create a bytes whose content is the whole bytes store.
Bytes	bytes(long offset, long length) Slice a Bytes object with start address of address+ offset and capacity of length.
void	close()
File	file()
void	force()
void	free()
long	index()
ObjectSerializer	objectSerializer()
int	refCount()
boolean	release()
static void	release(MappedMemory mapmem)
void	reserve()
long	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

MappedMemory

public MappedMemory(MappedByteBuffer buffer,
            long index)

Method Detail

index

public long index()

reserve

public void reserve()

Specified by:

reserve in interface ReferenceCounted

release

public boolean release()

Specified by:

release in interface ReferenceCounted

Returns:

true if release cause the ref count to drop to zero and the resource was freed

refCount

public int refCount()

Specified by:

refCount in interface ReferenceCounted

buffer

public MappedByteBuffer buffer()

address

public long address()

Specified by:

address in interface BytesStore

size

public long size()

Specified by:

size in interface BytesStore

free

public void free()

Specified by:

free in interface BytesStore

objectSerializer

public ObjectSerializer objectSerializer()

Specified by:

objectSerializer in interface BytesStore

file

public File file()

Specified by:

file in interface BytesStore

bytes

public Bytes bytes()

Description copied from interface: BytesStore

Create a bytes whose content is the whole bytes store. Call of this method is equivalent to bytes(0, size()) call.

Specified by:

bytes in interface BytesStore

Returns:

the new bytes

See Also:

BytesStore.bytes(long, long)

bytes

public Bytes bytes(long offset,
          long length)

Description copied from interface: BytesStore

Slice a Bytes object with start address of address+ offset and capacity of length.

If this BytesStore is Bytes itself rather than natural BytesStore object, this method will offset the new bytes from the bytes' start, not from bytes' position like BytesCommon.slice(long, long).

offset should be non-negative, length should be positive, offset + length should be less or equal to size.

Specified by:

bytes in interface BytesStore

Parameters:

offset - offset of the new bytes from the bytes store address

length - capacity and limit of the new bytes

Returns:

the sliced Bytes

See Also:

BytesStore.bytes()

release

public static void release(MappedMemory mapmem)

force

public void force()

close

public void close()