fiftyone.mobile.detection.entities.stream

Class Pool

java.lang.Object

fiftyone.mobile.detection.entities.stream.Pool

All Implemented Interfaces:

Closeable, AutoCloseable

public class Pool
extends Object
implements Closeable

As multiple threads need to read from the Source concurrently this class provides a mechanism for readers to be recycled across threads and requests.

Each data set constructed using the Stream Factory will maintain a pool of readers in order to perform device lookup and retrieve various entities.

Used by the BaseList of type T to provide multiple readers for the list.

The Dataset must be disposed of to ensure the readers in the pool are closed.

Objects of this class should not be created directly as they are part of the internal logic.

The concept of the pool is slightly different to that, used in our C API. The C API also maintains a pool, but it is a pool of work sets where each work set is constructed from the data set and contains device information relevant to the device being detected. This pool only contains readers.

The number of readers created by the pool will typically be limited to the number of concurrent threads in operation. As such the number of readers will be relatively small and the Pool does not need to limit the maximum number that can be created.

Constructor Summary

Constructors

Constructor and Description
Pool(SourceBase source) Constructs a new pool of readers for the SourceBase provided.

Method Summary

Modifier and Type	Method and Description
void	close()
BinaryReader	getReader() Returns a reader to the temp file for exclusive use.
int	getReadersCreated() The number of readers that have been created.
int	getReadersQueued() Returns The number of readers in the queue.
void	release(BinaryReader reader) Returns the reader to the pool to be used by another process later.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pool

public Pool(SourceBase source)

Constructs a new pool of readers for the SourceBase provided.

Parameters:

source - The data source for the list.

Method Detail

getReader

public BinaryReader getReader()
                       throws IOException

Returns a reader to the temp file for exclusive use. Release method must be called to return the reader to the pool when finished.

Returns:

Reader open and ready to read from the temp file.

Throws:

IOException - if there was a problem accessing data file.

release

public void release(BinaryReader reader)

Returns the reader to the pool to be used by another process later.

Parameters:

reader - Reader open and ready to read from the temp file

getReadersCreated

public int getReadersCreated()

The number of readers that have been created. May not be the same as the readers in the queue as some may be in use.

Returns:

The number of readers that have been created.

getReadersQueued

public int getReadersQueued()

Returns The number of readers in the queue.

Returns:

The number of readers in the queue.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException