com.inaccel.coral.shm

Interface SharedMemory

All Superinterfaces:

BackedByCube

All Known Implementing Classes:

SharedAbstractMatrix, SharedAbstractVector, SharedByteMatrix, SharedByteVector, SharedDoubleMatrix, SharedDoubleVector, SharedFloatMatrix, SharedFloatVector, SharedIntMatrix, SharedIntVector, SharedLongMatrix, SharedLongVector, SharedShortMatrix, SharedShortVector

public interface SharedMemory
extends BackedByCube

Interface for shared memory matrices/vectors, backed by shared memory cubes. Shared memory is created and destroyed via the alloc() and free() methods, respectively. Ideal for interprocess communication (IPC).

Method Summary

Modifier and Type	Method and Description
SharedMemory	alloc() Allocates the shared memory cube of this shared memory.
SharedMemory	free() Frees the shared memory cube of this shared memory.
int	unit() Returns the unit size (in bytes) of this shared memory.

Methods inherited from interface com.inaccel.coral.shm.BackedByCube

cube

Method Detail

unit

int unit()

Returns the unit size (in bytes) of this shared memory.

Returns:

The unit size.

alloc

SharedMemory alloc()
            throws Exception

Allocates the shared memory cube of this shared memory.

Returns:

This shared memory.

Throws:

Exception

free

SharedMemory free()
           throws Exception

Frees the shared memory cube of this shared memory.

Returns:

This shared memory.

Throws:

Exception