com.aspc.remote.memory

Class MemoryHandlerGroup

java.lang.Object

com.aspc.remote.memory.MemoryHandlerGroup

All Implemented Interfaces:

MemoryHandler

public class MemoryHandlerGroup
extends java.lang.Object
implements MemoryHandler

MemoryHandler
THREAD MODE: MULTI-THREADED memory management

Since:

15 November 1998

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from interface com.aspc.remote.memory.MemoryHandler

MemoryHandler.Cost

Constructor Summary

Constructors

Constructor and Description
MemoryHandlerGroup(java.lang.String description, MemoryHandler.Cost cost) Create a new memory group.

Method Summary

Modifier and Type	Method and Description
void	add(MemoryHandler handler) register a memory handler.
long	freeMemory(double percentage) Free memory at this level and below.
MemoryHandler.Cost	getCost() The cost level for this MemoryHandler.
java.lang.String	getDescription() The description
long	getEstimatedSize() The estimated size of data held by this memory handler
int	getHardLinkCount() How many items do we have a hard link on ?
long	getLastAccessed() The last time this memory handle was accessed
MemoryHandler[]	list() List of memory handlers that have been registered.
long	panicFreeMemory() Clear all memory ASAP.
long	queuedFreeMemory(double percentage) This method should implement the freeing of the method and maybe synchronized.
int	size() The estimated number of items held.
long	tidyUp() Tidy up the memory handler
java.lang.String	toString() The description

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryHandlerGroup

public MemoryHandlerGroup(@Nonnull
                          java.lang.String description,
                          @Nonnull
                          MemoryHandler.Cost cost)

Create a new memory group.

Parameters:

description - The description

cost - the cost

Method Detail

toString

@Nonnull
 @CheckReturnValue
public java.lang.String toString()

The description

Overrides:

toString in class java.lang.Object

Returns:

The description

getDescription

@Nonnull
 @CheckReturnValue
public java.lang.String getDescription()

The description

Returns:

the description

add

public void add(@Nonnull
                MemoryHandler handler)

register a memory handler.

Parameters:

handler - The memory handler to register.

getCost

@Nonnull
 @CheckReturnValue
public MemoryHandler.Cost getCost()

The cost level for this MemoryHandler.

Specified by:

getCost in interface MemoryHandler

Returns:

The cost

freeMemory

public 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()

Specified by:

freeMemory in interface MemoryHandler

Parameters:

percentage - to be freed

Returns:

the approximate amount freed

getHardLinkCount

@CheckReturnValue
public int getHardLinkCount()

How many items do we have a hard link on ?

Returns:

The count.

size

@CheckReturnValue
public int size()

The estimated number of items held.

Returns:

The count of the items held.

list

@Nonnull
 @CheckReturnValue
public MemoryHandler[] list()

List of memory handlers that have been registered.

Returns:

The list of handlers.

tidyUp

public long tidyUp()

Tidy up the memory handler

Specified by:

tidyUp in interface MemoryHandler

Returns:

The total bytes cleared.

panicFreeMemory

public long panicFreeMemory()

Clear all memory ASAP.

Specified by:

panicFreeMemory in interface MemoryHandler

Returns:

The estimated total number of bytes released.

queuedFreeMemory

public long queuedFreeMemory(@Nonnegative
                             double percentage)

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

Specified by:

queuedFreeMemory in interface MemoryHandler

Parameters:

percentage - The percentage to be cleared.

Returns:

the estimated amount cleared.

getEstimatedSize

@CheckReturnValue
 @Nonnegative
public long getEstimatedSize()

The estimated size of data held by this memory handler

Specified by:

getEstimatedSize in interface MemoryHandler

Returns:

The estimated number of bytes held.

getLastAccessed

@CheckReturnValue
public long getLastAccessed()

The last time this memory handle was accessed

Specified by:

getLastAccessed in interface MemoryHandler

Returns:

The last time in seconds this memory handler was accessed.