Elg2KeyFactory (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- java.lang.Thread
- - net.i2p.util.I2PThread
  - - net.i2p.router.crypto.ratchet.Elg2KeyFactory

All Implemented Interfaces:
Runnable, KeyFactory
```
public class Elg2KeyFactory
extends I2PThread
implements KeyFactory
```
Threaded factory for pre-calculating Elligator2-encoded X25519 key pairs to prevent Diffie-Hellman computation bottlenecks in critical paths Try to keep DH pairs at the ready. It's important to do this in a separate thread, because if we run out, the pairs are generated in the NTCP Pumper thread, and it can fall behind.

Nested Class Summary
- Nested classes/interfaces inherited from class net.i2p.util.I2PThread
  I2PThread.OOMEventListener
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary
- Fields inherited from class java.lang.Thread
  MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary
Constructors
Constructor and Description
Elg2KeyFactory(RouterContext ctx)
Creates factory and starts background key precomputation thread.

Constructors
Constructor and Description
`Elg2KeyFactory(RouterContext ctx)` Creates factory and starts background key precomputation thread.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Elg2KeyFactory`	`getInstance()` Returns the last created instance.
`Elg2KeyPair`	`getKeys()` Pulls a prebuilt keypair from the queue, or if not available, construct a new one.
`int`	`getMaxSize()` Returns the current maximum precalc queue size.
`int`	`getMinSize()` Returns the current minimum precalc queue size.
`int`	`getSize()` Returns the current number of precalc keys queued.
`void`	`refreshPoolSize()` Called by the Tuner every 30 seconds.
`void`	`returnUnused(Elg2KeyPair kp)` Return an unused DH key builder to be put back onto the queue for reuse.
`void`	`run()` Execute the task
`void`	`setMaxSize(int max)` Sets the maximum precalc queue size.
`void`	`setMinSize(int min)` Sets the minimum precalc queue size.
`void`	`shutdown()` Note that this stops the singleton precalc thread.

Methods inherited from class net.i2p.util.I2PThread
addOOMEventListener, fireOOM, removeOOMEventListener, start

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, stop, stop, suspend, toString, yield

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

- Constructor Detail
  - Elg2KeyFactory
```
public Elg2KeyFactory(RouterContext ctx)
```
    Creates factory and starts background key precomputation thread.
- Method Detail
  - getInstance
```
public static Elg2KeyFactory getInstance()
```
    Returns the last created instance.
    Returns:
    the instance
  - getKeys
```
public Elg2KeyPair getKeys()
```
    Pulls a prebuilt keypair from the queue, or if not available, construct a new one.
    Specified by:
    getKeys in interface KeyFactory
    Returns:
    the keys
  - getMaxSize
```
public int getMaxSize()
```
    Returns the current maximum precalc queue size.
    Returns:
    the max size
  - getMinSize
```
public int getMinSize()
```
    Returns the current minimum precalc queue size.
    Returns:
    the min size
  - getSize
```
public int getSize()
```
    Returns the current number of precalc keys queued.
    Returns:
    the size
  - refreshPoolSize
```
public void refreshPoolSize()
```
    Called by the Tuner every 30 seconds. Adjusts max pool size based on demand.
  - returnUnused
```
public void returnUnused(Elg2KeyPair kp)
```
    Return an unused DH key builder to be put back onto the queue for reuse.
  - run
```
public void run()
```
    Execute the task
    Specified by:
    run in interface Runnable
    Overrides:
    run in class I2PThread
  - setMaxSize
```
public void setMaxSize(int max)
```
    Sets the maximum precalc queue size.
  - setMinSize
```
public void setMinSize(int min)
```
    Sets the minimum precalc queue size.
  - shutdown
```
public void shutdown()
```
    Note that this stops the singleton precalc thread. You don't want to do this if there are multiple routers in the JVM. Fix this if you care. See Router.shutdown().

Class Elg2KeyFactory

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.util.I2PThread

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class net.i2p.util.I2PThread

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Constructor Detail

Elg2KeyFactory

Method Detail

getInstance

getKeys

getMaxSize

getMinSize

getSize

refreshPoolSize

returnUnused

run

setMaxSize

setMinSize

shutdown