JavetEnginePool (javet 4.1.3 API)

java.lang.Object
- com.caoccao.javet.interop.engine.JavetEnginePool<R>

Type Parameters:

R - the type parameter

All Implemented Interfaces:

IJavetClosable, IJavetEnginePool<R>, java.lang.AutoCloseable, java.lang.Runnable
```
public class JavetEnginePool<R extends V8Runtime>
extends java.lang.Object
implements IJavetEnginePool<R>, java.lang.Runnable
```
The type Javet engine pool.

Since:

0.8.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`active` The Active.
`protected JavetEngineConfig`	`config` The Config.
`protected java.lang.Thread`	`daemonThread` The Daemon thread.
`protected JavetEngine<R>[]`	`engines` The Engines.
`protected java.lang.Object`	`externalLock` The External lock.
`protected java.util.concurrent.ConcurrentLinkedQueue<java.lang.Integer>`	`idleEngineIndexList` The Idle engine index list.
`protected java.lang.Object`	`internalLock` The Internal lock.
`protected static java.lang.String`	`JAVET_DAEMON_THREAD_NAME` The constant JAVET_DAEMON_THREAD_NAME.
`protected boolean`	`quitting` The Quitting.
`protected java.util.Random`	`random` The Random.
`protected java.util.concurrent.ConcurrentLinkedQueue<java.lang.Integer>`	`releasedEngineIndexList` The Released engine index list.
`protected java.util.concurrent.Semaphore`	`semaphore` The Semaphore.

Constructor Summary

Constructors
Constructor and Description

JavetEnginePool()
Instantiates a new Javet engine pool.

JavetEnginePool(JavetEngineConfig config)
Instantiates a new Javet engine pool.

Constructors
Constructor and Description
`JavetEnginePool()` Instantiates a new Javet engine pool.
`JavetEnginePool(JavetEngineConfig config)` Instantiates a new Javet engine pool.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected JavetEngine<R>`	`createEngine()` Create engine javet engine.
`int`	`getActiveEngineCount()` Gets active engine count.
`JavetEngineConfig`	`getConfig()` Gets config.
`IJavetEngine<R>`	`getEngine()` Gets engine.
`int`	`getIdleEngineCount()` Gets idle engine count.
`int`	`getReleasedEngineCount()` Gets released engine count.
`protected java.time.ZonedDateTime`	`getUTCNow()` Gets utc now.
`V8SharedMemoryStatistics`	`getV8SharedMemoryStatistics()` Gets V8 shared memory statistics.
`boolean`	`isActive()` Is active.
`boolean`	`isClosed()` Is closed.
`boolean`	`isQuitting()` Is quitting boolean.
`int`	`observe(IV8RuntimeObserver<?>... observers)` Traverse the internal V8 runtimes, apply the observer and return the observed V8 runtime count.
`void`	`releaseEngine(IJavetEngine<R> iJavetEngine)` Release engine.
`void`	`run()`
`protected void`	`startDaemon()` Start daemon.
`protected void`	`stopDaemon()` Stop daemon.
`void`	`wakeUpDaemon()` Wake up the daemon thread explicitly.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.caoccao.javet.interop.engine.IJavetEnginePool
getAverageCallbackContextCount, getAverageReferenceCount, getAverageV8HeapSpaceStatistics, getAverageV8HeapStatistics, getAverageV8ModuleCount

- Field Detail
  - JAVET_DAEMON_THREAD_NAME
```
protected static final java.lang.String JAVET_DAEMON_THREAD_NAME
```
    The constant JAVET_DAEMON_THREAD_NAME.
    
    Since:
    
    0.8.10
    
    See Also:
    
    Constant Field Values
  - externalLock
```
protected final java.lang.Object externalLock
```
    The External lock.
    
    Since:
    
    0.8.10
  - idleEngineIndexList
```
protected final java.util.concurrent.ConcurrentLinkedQueue<java.lang.Integer> idleEngineIndexList
```
    The Idle engine index list.
    
    Since:
    
    1.0.5
  - internalLock
```
protected final java.lang.Object internalLock
```
    The Internal lock.
    
    Since:
    
    1.0.5
  - releasedEngineIndexList
```
protected final java.util.concurrent.ConcurrentLinkedQueue<java.lang.Integer> releasedEngineIndexList
```
    The Released engine index list.
    
    Since:
    
    1.0.5
  - active
```
protected volatile boolean active
```
    The Active.
    
    Since:
    
    0.7.0
  - config
```
protected JavetEngineConfig config
```
    The Config.
    
    Since:
    
    0.7.0
  - daemonThread
```
protected java.lang.Thread daemonThread
```
    The Daemon thread.
    
    Since:
    
    0.7.0
  - engines
```
protected JavetEngine<R extends V8Runtime>[] engines
```
    The Engines.
    
    Since:
    
    1.0.5
  - quitting
```
protected volatile boolean quitting
```
    The Quitting.
    
    Since:
    
    0.7.0
  - random
```
protected java.util.Random random
```
    The Random.
    
    Since:
    
    1.0.5
  - semaphore
```
protected java.util.concurrent.Semaphore semaphore
```
    The Semaphore.
    
    Since:
    
    1.1.6
- Constructor Detail
  - JavetEnginePool
```
public JavetEnginePool()
```
    Instantiates a new Javet engine pool.
    
    Since:
    
    0.7.0
  - JavetEnginePool
```
public JavetEnginePool(JavetEngineConfig config)
```
    Instantiates a new Javet engine pool.
    
    Parameters:
    
    config - the config
    
    Since:
    
    0.7.0
- Method Detail
  - close
```
public void close()
           throws JavetException
```
    Specified by:
    
    close in interface IJavetClosable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    JavetException
  - createEngine
```
protected JavetEngine<R> createEngine()
                               throws JavetException
```
    Create engine javet engine.
    
    Returns:
    
    the javet engine
    
    Throws:
    
    JavetException - the javet exception
    
    Since:
    
    0.7.0
  - getActiveEngineCount
```
public int getActiveEngineCount()
```
    Description copied from interface: IJavetEnginePool
    
    Gets active engine count.
    
    Specified by:
    
    getActiveEngineCount in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    the active engine count
  - getConfig
```
public JavetEngineConfig getConfig()
```
    Description copied from interface: IJavetEnginePool
    
    Gets config.
    
    Specified by:
    
    getConfig in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    the config
  - getEngine
```
public IJavetEngine<R> getEngine()
                          throws JavetException
```
    Description copied from interface: IJavetEnginePool
    
    Gets engine.
    
    Specified by:
    
    getEngine in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    the engine
    
    Throws:
    
    JavetException - the javet exception
  - getIdleEngineCount
```
public int getIdleEngineCount()
```
    Description copied from interface: IJavetEnginePool
    
    Gets idle engine count.
    
    Specified by:
    
    getIdleEngineCount in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    the idle engine count
  - getReleasedEngineCount
```
public int getReleasedEngineCount()
```
    Description copied from interface: IJavetEnginePool
    
    Gets released engine count.
    
    Specified by:
    
    getReleasedEngineCount in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    the released engine count
  - getUTCNow
```
protected java.time.ZonedDateTime getUTCNow()
```
    Gets utc now.
    
    Returns:
    
    the utc now
    
    Since:
    
    0.7.0
  - getV8SharedMemoryStatistics
```
public V8SharedMemoryStatistics getV8SharedMemoryStatistics()
```
    Description copied from interface: IJavetEnginePool
    
    Gets V8 shared memory statistics.
    
    Specified by:
    
    getV8SharedMemoryStatistics in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    the V8 shared memory statistics
  - isActive
```
public boolean isActive()
```
    Description copied from interface: IJavetEnginePool
    
    Is active.
    
    Specified by:
    
    isActive in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    true : active, false: inactive
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: IJavetClosable
    
    Is closed.
    
    Specified by:
    
    isClosed in interface IJavetClosable
    
    Returns:
    
    true : closed, false: not closed
  - isQuitting
```
public boolean isQuitting()
```
    Description copied from interface: IJavetEnginePool
    
    Is quitting boolean.
    
    Specified by:
    
    isQuitting in interface IJavetEnginePool<R extends V8Runtime>
    
    Returns:
    
    true : quitting, false: not quiting
  - observe
```
public int observe(IV8RuntimeObserver<?>... observers)
```
    Description copied from interface: IJavetEnginePool
    
    Traverse the internal V8 runtimes, apply the observer and return the observed V8 runtime count. This API is for collecting statistics. Executing code or changing the V8 runtime may result in inconsistent pool state or core dump.
    
    Specified by:
    
    observe in interface IJavetEnginePool<R extends V8Runtime>
    
    Parameters:
    
    observers - the observers
    
    Returns:
    
    the int
  - releaseEngine
```
public void releaseEngine(IJavetEngine<R> iJavetEngine)
```
    Description copied from interface: IJavetEnginePool
    
    Release engine.
    
    Specified by:
    
    releaseEngine in interface IJavetEnginePool<R extends V8Runtime>
    
    Parameters:
    
    iJavetEngine - the javet engine
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - startDaemon
```
protected void startDaemon()
```
    Start daemon.
    
    Since:
    
    0.7.0
  - stopDaemon
```
protected void stopDaemon()
```
    Stop daemon.
    
    Since:
    
    0.7.0
  - wakeUpDaemon
```
public void wakeUpDaemon()
```
    Description copied from interface: IJavetEnginePool
    
    Wake up the daemon thread explicitly.
    
    Specified by:
    
    wakeUpDaemon in interface IJavetEnginePool<R extends V8Runtime>

Class JavetEnginePool<R extends V8Runtime>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.caoccao.javet.interop.engine.IJavetEnginePool

Field Detail

JAVET_DAEMON_THREAD_NAME

externalLock

idleEngineIndexList

internalLock

releasedEngineIndexList

active

config

daemonThread

engines

quitting

random

semaphore

Constructor Detail

JavetEnginePool

JavetEnginePool

Method Detail

close

createEngine

getActiveEngineCount

getConfig

getEngine

getIdleEngineCount

getReleasedEngineCount

getUTCNow

getV8SharedMemoryStatistics

isActive

isClosed

isQuitting

observe

releaseEngine

run

startDaemon

stopDaemon

wakeUpDaemon