com.scaleoutsoftware.soss.hserver.interop

Class ChunkedCollectionWriter<KEY,VALUE>

java.lang.Object

com.scaleoutsoftware.soss.hserver.interop.ChunkedCollectionWriter<KEY,VALUE>

Type Parameters:

KEY - key type

VALUE - value type

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DataGridChunkedCollectionWriter

public abstract class ChunkedCollectionWriter<KEY,VALUE>
extends Object
implements Closeable

This is the base class for chunked collection writers. Chunked collection writers organize a stream of key-value entries into chunks and write them out to the distributed in-memory data grid so that they can be retrieved in the same order by a ChunkedCollectionReader. It uses a thread pool to concurrently write key-value entries to the grid.

When an object is added to the chunk collection by put(Object, Object), it is written to the byte buffer of the current active assembling chunk by putObject(java.io.DataOutputStream, java.nio.ByteBuffer, int, Object, Object). When the chunk is full, it is added to the write queue and the output is redirected to the next assembling chunk. Chunks are written out asynchronously by calling writeChunkOut(java.nio.ByteBuffer, int, int).

The writer should be (close())d to finalize output when there are no more objects to write.

Constructor Summary

Constructors

Constructor and Description
ChunkedCollectionWriter(com.scaleoutsoftware.soss.client.map.impl.ChunkBufferPool chunkBufferPool) Creates the chunk writer.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Releases all chunk buffers back into the thread pool.
void	close() Closes the chunk writer.
int	getNumberOfChunks() Gets the number of written chunks.
void	put(KEY key, VALUE value) Puts the key and value into the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkedCollectionWriter

public ChunkedCollectionWriter(com.scaleoutsoftware.soss.client.map.impl.ChunkBufferPool chunkBufferPool)
                        throws IOException

Creates the chunk writer.

Parameters:

chunkBufferPool - the pool of chunks to write to

Throws:

IOException - If a write error occurs

Method Detail

close

public void close()
           throws IOException

Closes the chunk writer. This will cause the assembling chunk to be written to the distributed in-memory data grid. This method will block until all writes are complete.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an error occurred while writing chunks out

cleanup

public void cleanup()

Releases all chunk buffers back into the thread pool.

getNumberOfChunks

public int getNumberOfChunks()

Gets the number of written chunks. This method should only be used after close() is called.

Returns:

the number of chunks written to the in-memory data grid

put

public void put(KEY key,
                VALUE value)
         throws IOException

Puts the key and value into the collection.

Parameters:

key - key object

value - value object

Throws:

IOException - if write error occurred