MemoryPool (Stardog-5.2.2 API)

All Superinterfaces:

AutoCloseable, Disposable
```
public interface MemoryPool
extends Disposable, AutoCloseable
```
A pool of memory from which allocations can occur.

Since:

2.1

Version:

4.0

Author:

Michael Grove

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class MemoryPool.Type

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MemoryPool.Type`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`calloc(long theSize)` Allocate memory from this pool and zero it
`boolean`	`canAllocate(long theSize)` Returns whether or not the pool can perform an allocation of the given size.
`void`	`close()`
`default void`	`dispose()` Clean up this memory pool.
`boolean`	`free(long theAddress)` Return the memory at the given address to the pool
`default String`	`getName()` Returns the name of the memory pool
`MemoryPool.Type`	`getType()` Return the type of memory in the pool
`default boolean`	`isEmpty()` Return whether or not there is any memory left in this pool.
`long`	`malloc(long theSize)` Allocate memory from this pool.
`long`	`memLeft()` Return how many bytes remain in this pool
`long`	`size()` Return the total size of the memory pool
`MemoryPool`	`slice(long theSize)` Create a child pool of the given size.

- Method Detail
  - getName
```
default String getName()
```
    Returns the name of the memory pool
    
    Returns:
    
    the pool
  - getType
```
MemoryPool.Type getType()
```
    Return the type of memory in the pool
  - close
```
void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - dispose
```
default void dispose()
```
    Clean up this memory pool. This will automatically free all memory allocated by this pool which has not already been released as well as disposing of all child pools.
    
    Specified by:
    
    dispose in interface Disposable
  - malloc
```
long malloc(long theSize)
```
    Allocate memory from this pool.
    
    Parameters:
    
    theSize - the amount of memory to allocate
    
    Returns:
    
    the address of the allocated memory
    
    Throws:
    
    NotEnoughMemoryException - if the pool does not have enough memory to complete the allocation
  - calloc
```
long calloc(long theSize)
```
    Allocate memory from this pool and zero it
    
    Parameters:
    
    theSize - the amount of memory to allocate
    
    Returns:
    
    the address of the allocated, zeroed memory
    
    Throws:
    
    NotEnoughMemoryException - if the pool does not have enough memory to complete the allocation
  - free
```
boolean free(long theAddress)
```
    Return the memory at the given address to the pool
    
    Parameters:
    
    theAddress - the address
    
    Returns:
    
    true if the memory was freed, false otherwise
  - canAllocate
```
boolean canAllocate(long theSize)
```
    Returns whether or not the pool can perform an allocation of the given size.
    
    Parameters:
    
    theSize - the size of the allocation
    
    Returns:
    
    true if the allocation can be performed, false otherwise
  - isEmpty
```
default boolean isEmpty()
```
    Return whether or not there is any memory left in this pool. Equivalent to memLeft() == 0
    
    Returns:
    
    true if the pool is empty, false otherwise
  - memLeft
```
long memLeft()
```
    Return how many bytes remain in this pool
    
    Returns:
    
    the amount of memory left in the pool
  - size
```
long size()
```
    Return the total size of the memory pool
    
    Returns:
    
    the size of the pool
  - slice
```
MemoryPool slice(long theSize)
```
    Create a child pool of the given size. When the child pool is closed, its resources are returned to this pool and when this pool is closed, its child pools are closed.
    
    Parameters:
    
    theSize - the size of the child pool
    
    Returns:
    
    the new pool.

Interface MemoryPool

Nested Class Summary

Method Summary

Method Detail

getName

getType

close

dispose

malloc

calloc

free

canAllocate

isEmpty

memLeft

size

slice