Package org.apache.tomcat.jni
Class Pool
java.lang.Object
org.apache.tomcat.jni.Pool
Provides access to APR memory pools which are used to manage memory
 allocations for natively created instances.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic ByteBufferalloc(long p, int size) Deprecated.Unused.static ByteBuffercalloc(long p, int size) Deprecated.Unused.static voidDeprecated.Unused.static voidcleanupKill(long pool, long data) Deprecated.Unused.static longcleanupRegister(long pool, Object o) Deprecated.Unused.static voidclear(long pool) Deprecated.Unused.static longcreate(long parent) Create a new pool.static ObjectDeprecated.Unused.static intDeprecated.Unused.static voiddestroy(long pool) Destroy the pool.static booleanisAncestor(long a, long b) Deprecated.Unused.static voidnoteSubprocess(long a, long proc, int how) Deprecated.Unused.static longparentGet(long pool) Deprecated.Unused.
- 
Constructor Details- 
Poolpublic Pool()
 
- 
- 
Method Details- 
createpublic static long create(long parent) Create a new pool.- Parameters:
- parent- The parent pool. If this is 0, the new pool is a root pool. If it is non-zero, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool.
- Returns:
- The pool we have just created.
 
- 
clearDeprecated.Unused. Will be removed in Tomcat 10.1Clear all memory in the pool and run all the cleanups. This also destroys all subpools.- Parameters:
- pool- The pool to clear This does not actually free the memory, it just allows the pool to re-use this memory for the next allocation.
 
- 
destroypublic static void destroy(long pool) Destroy the pool. This takes similar action as apr_pool_clear() and then frees all the memory. This will actually free the memory.- Parameters:
- pool- The pool to destroy
 
- 
parentGetDeprecated.Unused. Will be removed in Tomcat 10.1Get the parent pool of the specified pool.- Parameters:
- pool- The pool for retrieving the parent pool.
- Returns:
- The parent of the given pool.
 
- 
isAncestorDeprecated.Unused. Will be removed in Tomcat 10.1Determine if pool a is an ancestor of pool b- Parameters:
- a- The pool to search
- b- The pool to search for
- Returns:
- True if a is an ancestor of b, NULL is considered an ancestor of all pools.
 
- 
cleanupRegisterDeprecated.Unused. Will be removed in Tomcat 10.1Register a function to be called when a pool is cleared or destroyed- Parameters:
- pool- The pool register the cleanup with
- o- The object to call when the pool is cleared or destroyed
- Returns:
- The cleanup handler.
 
- 
cleanupKillDeprecated.Unused. Will be removed in Tomcat 10.1Remove a previously registered cleanup function- Parameters:
- pool- The pool remove the cleanup from
- data- The cleanup handler to remove from cleanup
 
- 
noteSubprocessDeprecated.Unused. Will be removed in Tomcat 10.1Register a process to be killed when a pool dies.- Parameters:
- a- The pool to use to define the processes lifetime
- proc- The process to register
- how- How to kill the process, one of:- APR_KILL_NEVER -- process is never sent any signals APR_KILL_ALWAYS -- process is sent SIGKILL on apr_pool_t cleanup APR_KILL_AFTER_TIMEOUT -- SIGTERM, wait 3 seconds, SIGKILL APR_JUST_WAIT -- wait forever for the process to complete APR_KILL_ONLY_ONCE -- send SIGTERM and then wait 
 
- 
allocDeprecated.Unused. Will be removed in Tomcat 10.1Allocate a block of memory from a pool- Parameters:
- p- The pool to allocate from
- size- The amount of memory to allocate
- Returns:
- The ByteBuffer with allocated memory
 
- 
callocDeprecated.Unused. Will be removed in Tomcat 10.1Allocate a block of memory from a pool and set all of the memory to 0- Parameters:
- p- The pool to allocate from
- size- The amount of memory to allocate
- Returns:
- The ByteBuffer with allocated memory
 
- 
dataSetDeprecated.Unused. Will be removed in Tomcat 10.1Set the data associated with the current pool- Parameters:
- data- The user data associated with the pool.
- key- The key to use for association
- pool- The current pool
 Warning : The data to be attached to the pool should have a life span at least as long as the pool it is being attached to. Object attached to the pool will be globally referenced until the pool is cleared or dataSet is called with the null data.
- Returns:
- APR Status code.
 
- 
dataGetDeprecated.Unused. Will be removed in Tomcat 10.1Return the data associated with the current pool.- Parameters:
- key- The key for the data to retrieve
- pool- The current pool.
- Returns:
- the data
 
- 
cleanupForExecDeprecated.Unused. Will be removed in Tomcat 10.1Run all of the child_cleanups, so that any unnecessary files are closed because we are about to exec a new program
 
-