com.aspc.remote.memory

Interface MemoryHandler

All Known Implementing Classes:

CacheLongTable, CacheTable, CacheTableTemplate, ForkJoinDataSource, MemoryHandlerGroup, MutableDataSource, ResetableCacheLongTable, RootClassHolder, SanityCheckDataSource, SlowMemoryHandler, SortedResultsMap, SudoDataSource, VirtualDB

public interface MemoryHandler

MemoryHandler
THREAD MODE: MULTI-THREADED

Since:

15 November 1998

Author:

Nigel Leck

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MemoryHandler.Cost

Method Summary

Modifier and Type	Method and Description
long	freeMemory(double percentage) Free memory at this level and below.
MemoryHandler.Cost	getCost() The cost level for this MemoryHandler.
long	getEstimatedSize() The estimated size of data held by this memory handler
long	getLastAccessed() The last time this memory handle was accessed
long	panicFreeMemory() Clear all memory.
long	queuedFreeMemory(double percentage) This method should implement the freeing of the method and maybe synchronized.
long	tidyUp() Tidy up the memory handler

Method Detail

getCost

@Nonnull
 @CheckReturnValue
MemoryHandler.Cost getCost()

The cost level for this MemoryHandler.

Returns:

The cost

freeMemory

@Nonnegative
long freeMemory(@Nonnegative
                             double percentage)

Free memory at this level and below.
To prevent a possible deadlock this method should not be synchronized. It should call MemoryManager.callFreeMemory which in turn calls queuedFreeMemory()

Parameters:

percentage - to be freed

Returns:

the approximate amount freed

tidyUp

@Nonnegative
long tidyUp()

Tidy up the memory handler

Returns:

the total bytes cleared.

queuedFreeMemory

@Nonnegative
long queuedFreeMemory(@Nonnegative
                                   double percentage)

This method should implement the freeing of the method and maybe synchronized.

Parameters:

percentage - The percentage to be cleared.

Returns:

the estimated amount cleared.

panicFreeMemory

@Nonnegative
long panicFreeMemory()

Clear all memory.

Returns:

the estimated amount cleared.

getEstimatedSize

@CheckReturnValue
 @Nonnegative
long getEstimatedSize()

The estimated size of data held by this memory handler

Returns:

The estimated number of bytes held.

getLastAccessed

@CheckReturnValue
 @Nonnegative
long getLastAccessed()

The last time this memory handle was accessed

Returns:

The last time in seconds this memory handler was accessed.