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 is to be freed.
Memory	request(long capacityBytes) Request new Memory with the given capacity.
Memory	request(Memory origMem, long copyToBytes, long capacityBytes) Request for allocate, copy and clear.

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. It may be null.

request

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

Request for allocate, copy and clear.

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

Parameters:

origMem - The original Memory, a portion of which will be copied to the newly allocated Memory. The reference must not be null. This origMem is not modified in any way, may be reused and must be freed appropriately.

copyToBytes - the upper limit of the region to be copied from origMem to the newly allocated memory.

capacityBytes - the desired new capacity of the newly allocated memory in bytes and the upper limit of the region to be cleared.

Returns:

The new Memory with the given capacity. It may be null.

free

void free(Memory mem)

The given Memory with its capacity is to be freed

Parameters:

mem - The Memory to be freed

free

void free(Memory memToFree,
          Memory newMem)

The given memToFree with its capacity is to be freed. Providing a reference to the newly granted Memory enables the receiver of the callback to link the Memory to be freed with this new Memory.

Parameters:

memToFree - the Memory to be freed.

newMem - this reference enables the receiver of the callback to link the Memory to be freed with this new Memory.