ExtentHooks (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.system.jemalloc.ExtentHooks

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ExtentHooks
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
The extent_hooks_t structure comprises function pointers which are described individually below. jemalloc uses these functions to manage extent lifetime, which starts off with allocation of mapped committed memory, in the simplest case followed by deallocation. However, there are performance and platform reasons to retain extents for later reuse. Cleanup attempts cascade from deallocation to decommit to forced purging to lazy purging, which gives the extent management functions opportunities to reject the most permanent cleanup operations in favor of less permanent (and often less costly) operations. All operations except allocation can be universally opted out of by setting the hook pointers to NULL, or selectively opted out of by returning failure.
Member documentation
- alloc – the extent allocation hook
- dalloc – the extent deallocation hook
- destroy – the extent destruction hook
- commit – the extent commit hook
- decommit – the extent decommit hook
- purge_lazy – the extent lazy purge hook
- purge_forced – the extent forced purge hook
- split – the extent split hook
- merge – the extent merge hook
Layout
```
 struct extent_hooks_t {
     extent_alloc_t alloc;
     extent_dalloc_t dalloc;
     extent_destroy_t destroy;
     extent_commit_t commit;
     extent_decommit_t decommit;
     extent_purge_t purge_lazy;
     extent_purge_t purge_forced;
     extent_split_t split;
     extent_merge_t merge;
 }
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ALLOC` The struct member offsets.
`static int`	`COMMIT` The struct member offsets.
`static int`	`DALLOC` The struct member offsets.
`static int`	`DECOMMIT` The struct member offsets.
`static int`	`DESTROY` The struct member offsets.
`static int`	`MERGE` The struct member offsets.
`static int`	`PURGE_FORCED` The struct member offsets.
`static int`	`PURGE_LAZY` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SPLIT` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

ExtentHooks(java.nio.ByteBuffer container)
Creates a ExtentHooks instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`ExtentHooks(java.nio.ByteBuffer container)` Creates a `ExtentHooks` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExtentAlloc`	`alloc()` Returns the value of the `alloc` field.
`ExtentHooks`	`alloc(ExtentAllocI value)` Sets the specified value to the `alloc` field.
`static ExtentHooks`	`calloc()` Returns a new `ExtentHooks` instance allocated with `memCalloc`.
`static ExtentHooks`	`callocStack()` Returns a new `ExtentHooks` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ExtentHooks`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ExtentHooks` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`ExtentCommit`	`commit()` Returns the value of the `commit` field.
`ExtentHooks`	`commit(ExtentCommitI value)` Sets the specified value to the `commit` field.
`static ExtentHooks`	`create()` Returns a new `ExtentHooks` instance allocated with `BufferUtils`.
`static ExtentHooks`	`create(long address)` Returns a new `ExtentHooks` instance for the specified memory address.
`static ExtentHooks`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`ExtentDalloc`	`dalloc()` Returns the value of the `dalloc` field.
`ExtentHooks`	`dalloc(ExtentDallocI value)` Sets the specified value to the `dalloc` field.
`ExtentDecommit`	`decommit()` Returns the value of the `decommit` field.
`ExtentHooks`	`decommit(ExtentDecommitI value)` Sets the specified value to the `decommit` field.
`ExtentDestroy`	`destroy()` Returns the value of the `destroy` field.
`ExtentHooks`	`destroy(ExtentDestroyI value)` Sets the specified value to the `destroy` field.
`static ExtentHooks`	`malloc()` Returns a new `ExtentHooks` instance allocated with `memAlloc`.
`static ExtentHooks`	`mallocStack()` Returns a new `ExtentHooks` instance allocated on the thread-local `MemoryStack`.
`static ExtentHooks`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ExtentHooks` instance allocated on the specified `MemoryStack`.
`ExtentMerge`	`merge()` Returns the value of the `merge` field.
`ExtentHooks`	`merge(ExtentMergeI value)` Sets the specified value to the `merge` field.
`static ExtentAlloc`	`nalloc(long struct)` Unsafe version of `alloc()`.
`static void`	`nalloc(long struct, ExtentAllocI value)` Unsafe version of `alloc`.
`static ExtentCommit`	`ncommit(long struct)` Unsafe version of `commit()`.
`static void`	`ncommit(long struct, ExtentCommitI value)` Unsafe version of `commit`.
`static ExtentDalloc`	`ndalloc(long struct)` Unsafe version of `dalloc()`.
`static void`	`ndalloc(long struct, ExtentDallocI value)` Unsafe version of `dalloc`.
`static ExtentDecommit`	`ndecommit(long struct)` Unsafe version of `decommit()`.
`static void`	`ndecommit(long struct, ExtentDecommitI value)` Unsafe version of `decommit`.
`static ExtentDestroy`	`ndestroy(long struct)` Unsafe version of `destroy()`.
`static void`	`ndestroy(long struct, ExtentDestroyI value)` Unsafe version of `destroy`.
`static ExtentMerge`	`nmerge(long struct)` Unsafe version of `merge()`.
`static void`	`nmerge(long struct, ExtentMergeI value)` Unsafe version of `merge`.
`static ExtentPurge`	`npurge_forced(long struct)` Unsafe version of `purge_forced()`.
`static void`	`npurge_forced(long struct, ExtentPurgeI value)` Unsafe version of `purge_forced`.
`static ExtentPurge`	`npurge_lazy(long struct)` Unsafe version of `purge_lazy()`.
`static void`	`npurge_lazy(long struct, ExtentPurgeI value)` Unsafe version of `purge_lazy`.
`static ExtentSplit`	`nsplit(long struct)` Unsafe version of `split()`.
`static void`	`nsplit(long struct, ExtentSplitI value)` Unsafe version of `split`.
`ExtentPurge`	`purge_forced()` Returns the value of the `purge_forced` field.
`ExtentHooks`	`purge_forced(ExtentPurgeI value)` Sets the specified value to the `purge_forced` field.
`ExtentPurge`	`purge_lazy()` Returns the value of the `purge_lazy` field.
`ExtentHooks`	`purge_lazy(ExtentPurgeI value)` Sets the specified value to the `purge_lazy` field.
`ExtentHooks`	`set(ExtentAllocI alloc, ExtentDallocI dalloc, ExtentDestroyI destroy, ExtentCommitI commit, ExtentDecommitI decommit, ExtentPurgeI purge_lazy, ExtentPurgeI purge_forced, ExtentSplitI split, ExtentMergeI merge)` Initializes this struct with the specified values.
`ExtentHooks`	`set(ExtentHooks src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`ExtentSplit`	`split()` Returns the value of the `split` field.
`ExtentHooks`	`split(ExtentSplitI value)` Sets the specified value to the `split` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Field Detail
- SIZEOF
```
public static final int SIZEOF
```
  The struct size in bytes.
- ALIGNOF
```
public static final int ALIGNOF
```
  The struct alignment in bytes.
- ALLOC
```
public static final int ALLOC
```
  The struct member offsets.
- DALLOC
```
public static final int DALLOC
```
  The struct member offsets.
- DESTROY
```
public static final int DESTROY
```
  The struct member offsets.
- COMMIT
```
public static final int COMMIT
```
  The struct member offsets.
- DECOMMIT
```
public static final int DECOMMIT
```
  The struct member offsets.
- PURGE_LAZY
```
public static final int PURGE_LAZY
```
  The struct member offsets.
- PURGE_FORCED
```
public static final int PURGE_FORCED
```
  The struct member offsets.
- SPLIT
```
public static final int SPLIT
```
  The struct member offsets.
- MERGE
```
public static final int MERGE
```
  The struct member offsets.

Constructor Detail
- ExtentHooks
```
public ExtentHooks(java.nio.ByteBuffer container)
```
  Creates a ExtentHooks instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
  The created instance holds a strong reference to the container object.

Method Detail

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

alloc
```
public ExtentAlloc alloc()
```
Returns the value of the alloc field.

dalloc

@Nullable
public ExtentDalloc dalloc()

Returns the value of the dalloc field.

destroy

@Nullable
public ExtentDestroy destroy()

Returns the value of the destroy field.

commit

@Nullable
public ExtentCommit commit()

Returns the value of the commit field.

decommit

@Nullable
public ExtentDecommit decommit()

Returns the value of the decommit field.

purge_lazy
```
@Nullable
public ExtentPurge purge_lazy()
```
Returns the value of the purge_lazy field.

purge_forced
```
@Nullable
public ExtentPurge purge_forced()
```
Returns the value of the purge_forced field.

split
```
@Nullable
public ExtentSplit split()
```
Returns the value of the split field.

merge
```
@Nullable
public ExtentMerge merge()
```
Returns the value of the merge field.

alloc

public ExtentHooks alloc(ExtentAllocI value)

Sets the specified value to the alloc field.

dalloc

public ExtentHooks dalloc(@Nullable
                          ExtentDallocI value)

Sets the specified value to the dalloc field.

destroy

public ExtentHooks destroy(@Nullable
                           ExtentDestroyI value)

Sets the specified value to the destroy field.

commit

public ExtentHooks commit(@Nullable
                          ExtentCommitI value)

Sets the specified value to the commit field.

decommit

public ExtentHooks decommit(@Nullable
                            ExtentDecommitI value)

Sets the specified value to the decommit field.

purge_lazy

public ExtentHooks purge_lazy(@Nullable
                              ExtentPurgeI value)

Sets the specified value to the purge_lazy field.

purge_forced

public ExtentHooks purge_forced(@Nullable
                                ExtentPurgeI value)

Sets the specified value to the purge_forced field.

split

public ExtentHooks split(@Nullable
                         ExtentSplitI value)

Sets the specified value to the split field.

merge

public ExtentHooks merge(@Nullable
                         ExtentMergeI value)

Sets the specified value to the merge field.

set

public ExtentHooks set(ExtentAllocI alloc,
                       ExtentDallocI dalloc,
                       ExtentDestroyI destroy,
                       ExtentCommitI commit,
                       ExtentDecommitI decommit,
                       ExtentPurgeI purge_lazy,
                       ExtentPurgeI purge_forced,
                       ExtentSplitI split,
                       ExtentMergeI merge)

Initializes this struct with the specified values.

set
```
public ExtentHooks set(ExtentHooks src)
```
Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc
```
public static ExtentHooks malloc()
```
Returns a new ExtentHooks instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static ExtentHooks calloc()
```
Returns a new ExtentHooks instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static ExtentHooks create()
```
Returns a new ExtentHooks instance allocated with BufferUtils.

create
```
public static ExtentHooks create(long address)
```
Returns a new ExtentHooks instance for the specified memory address.

createSafe

@Nullable
public static ExtentHooks createSafe(long address)

Like create, but returns null if address is NULL.

mallocStack
```
public static ExtentHooks mallocStack()
```
Returns a new ExtentHooks instance allocated on the thread-local MemoryStack.

callocStack
```
public static ExtentHooks callocStack()
```
Returns a new ExtentHooks instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static ExtentHooks mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new ExtentHooks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static ExtentHooks callocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new ExtentHooks instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

nalloc

public static ExtentAlloc nalloc(long struct)

Unsafe version of alloc().

ndalloc

@Nullable
public static ExtentDalloc ndalloc(long struct)

Unsafe version of dalloc().

ndestroy

@Nullable
public static ExtentDestroy ndestroy(long struct)

Unsafe version of destroy().

ncommit

@Nullable
public static ExtentCommit ncommit(long struct)

Unsafe version of commit().

ndecommit

@Nullable
public static ExtentDecommit ndecommit(long struct)

Unsafe version of decommit().

npurge_lazy

@Nullable
public static ExtentPurge npurge_lazy(long struct)

Unsafe version of purge_lazy().

npurge_forced

@Nullable
public static ExtentPurge npurge_forced(long struct)

Unsafe version of purge_forced().

nsplit

@Nullable
public static ExtentSplit nsplit(long struct)

Unsafe version of split().

nmerge

@Nullable
public static ExtentMerge nmerge(long struct)

Unsafe version of merge().

nalloc

public static void nalloc(long struct,
                          ExtentAllocI value)

Unsafe version of alloc.

ndalloc

public static void ndalloc(long struct,
                           @Nullable
                           ExtentDallocI value)

Unsafe version of dalloc.

ndestroy

public static void ndestroy(long struct,
                            @Nullable
                            ExtentDestroyI value)

Unsafe version of destroy.

ncommit

public static void ncommit(long struct,
                           @Nullable
                           ExtentCommitI value)

Unsafe version of commit.

ndecommit

public static void ndecommit(long struct,
                             @Nullable
                             ExtentDecommitI value)

Unsafe version of decommit.

npurge_lazy

public static void npurge_lazy(long struct,
                               @Nullable
                               ExtentPurgeI value)

Unsafe version of purge_lazy.

npurge_forced

public static void npurge_forced(long struct,
                                 @Nullable
                                 ExtentPurgeI value)

Unsafe version of purge_forced.

nsplit

public static void nsplit(long struct,
                          @Nullable
                          ExtentSplitI value)

Unsafe version of split.

nmerge

public static void nmerge(long struct,
                          @Nullable
                          ExtentMergeI value)

Unsafe version of merge.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

validate
```
public static void validate(long array,
                            int count)
```
Calls validate(long) for each struct contained in the specified struct array.

Parameters:

array - the struct array to validate

count - the number of structs in array

Class ExtentHooks

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ALLOC

DALLOC

DESTROY

COMMIT

DECOMMIT

PURGE_LAZY

PURGE_FORCED

SPLIT

MERGE

Constructor Detail

ExtentHooks

Method Detail

sizeof

alloc

dalloc

destroy

commit

decommit

purge_lazy

purge_forced

split

merge

alloc

dalloc

destroy

commit

decommit

purge_lazy

purge_forced

split

merge

set

set

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

nalloc

ndalloc

ndestroy

ncommit

ndecommit

npurge_lazy

npurge_forced

nsplit

nmerge

nalloc

ndalloc

ndestroy

ncommit

ndecommit

npurge_lazy

npurge_forced

nsplit

nmerge

validate

validate