com.yahoo.memory

Interface MemoryRequest

public interface MemoryRequest

The MemoryRequest is a callback interface that is accessible from the Memory interface and provides a means for a Memory object to request more memory from the calling class and to free Memory that is no longer needed.

Author:

Lee Rhodes

Method Summary

Modifier and Type	Method and Description
void	free(Memory mem) The given Memory with its capacity is to be freed.
void	free(Memory memToFree, Memory newMem) The given memToFree with its capacity may be freed by the implementation.
Memory	request(long capacityBytes) Request new Memory with the given capacity.
Memory	request(Memory origMem, long copyToBytes, long capacityBytes) Request for allocate and copy.

Method Detail

request

Memory request(long capacityBytes)

Request new Memory with the given capacity.

Parameters:

capacityBytes - The capacity being requested

Returns:

new Memory with the given capacity. If this request is refused it will be null.

request

Memory request(Memory origMem,
               long copyToBytes,
               long capacityBytes)

Request for allocate and copy.

Request to allocate new Memory with the capacityBytes; copy the contents of origMem from zero to copyToBytes.

Parameters:

origMem - The original Memory, a portion, starting at zero, which will be copied to the newly allocated Memory. This reference must not be null. This origMem must not modified in any way, and may be reused or freed by the implementation. The requesting application may NOT assume anything about the origMem.

copyToBytes - the upper limit of the region to be copied from origMem to the newly allocated memory. The upper region of the new Memory may or may not be cleared depending on the implementation.

capacityBytes - the desired new capacity of the newly allocated memory in bytes.

Returns:

The new Memory with the given capacity. If this request is refused it will be null.

free

void free(Memory mem)

The given Memory with its capacity is to be freed. It is assumed that the implementation of this interface knows the type of Memory that was created and how to free it.

Parameters:

mem - The Memory to be freed

free

void free(Memory memToFree,
          Memory newMem)

The given memToFree with its capacity may be freed by the implementation. Providing a reference to newMem enables the implementation to link the memToFree to the newMem, if desired.

Parameters:

memToFree - the Memory to be freed. It is assumed that the implementation of this interface knows the type of Memory that was created and how to free it, if desired.

newMem - Providing a reference to newMem enables the implementation to link the memToFree to the newMem, if desired.