DefaultSelectorLoopPool (SNF4J 1.10.0 API)

java.lang.Object
- org.snf4j.core.IdentifiableObject
- - org.snf4j.core.pool.DefaultSelectorLoopPool

All Implemented Interfaces:

ISelectorLoopPool
```
public class DefaultSelectorLoopPool
extends IdentifiableObject
implements ISelectorLoopPool
```
Default implementation for selector loop pool that is backed by an fixed-size array of selector loops.
This implementation is not thread safe.

Author:

SNF4J.ORG

Field Summary

Fields
Modifier and Type	Field and Description
`protected SelectorLoop[]`	`pool` The backing array for this selector-pool
`protected ISelectorLoopStructureFactory`	`selectorFactory` A factory used to create selectors for all selector loops in this pool
`protected int`	`size` The current size of this pool
`protected ThreadFactory`	`threadFactory` A factory used to create threads for all selector loops in this pool

Constructor Summary

Constructors
Constructor and Description
`DefaultSelectorLoopPool(int capacity)` Constructs a unnamed selector loop pool with given capacity.
`DefaultSelectorLoopPool(String name, int capacity)` Constructs a named selector loop pool with given capacity.
`DefaultSelectorLoopPool(String name, int capacity, ThreadFactory threadFactory, ISelectorLoopStructureFactory selectorFactory)` Constructs a named selector loop pool with given capacity and thread factory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCapacity()` Gets the capacity of this pool.
`SelectorLoop`	`getLoop(SelectableChannel channel)` Gets the best selector loop from this pool that should be used to process given channel.
`SelectorLoop[]`	`getPool()` Gets an array of all selector loops created in this pool.
`int`	`getSize()` Gets the current size of this pool.
`void`	`join()` Waits for all selector loop's threads to die.
`boolean`	`join(long millis)` Waits at most `millis` milliseconds for all selector loop's threads to die.
`void`	`quickStop()` Quickly stops all selector loops in this pool.
`void`	`stop()` Gently stops all selector loops in this pool.
`void`	`update(SelectorLoop loop, int newSize, int prevSize)` Notifies the pool that given selector loop is now processing different number of channels.

Methods inherited from class org.snf4j.core.IdentifiableObject
getId, getName, toString

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

- Field Detail
  - pool
```
protected final SelectorLoop[] pool
```
    The backing array for this selector-pool
  - threadFactory
```
protected final ThreadFactory threadFactory
```
    A factory used to create threads for all selector loops in this pool
  - selectorFactory
```
protected final ISelectorLoopStructureFactory selectorFactory
```
    A factory used to create selectors for all selector loops in this pool
  - size
```
protected int size
```
    The current size of this pool
- Constructor Detail
  - DefaultSelectorLoopPool
```
public DefaultSelectorLoopPool(String name,
                               int capacity,
                               ThreadFactory threadFactory,
                               ISelectorLoopStructureFactory selectorFactory)
```
    Constructs a named selector loop pool with given capacity and thread factory.
    
    Parameters:
    
    name - the name of the pool or null if the name should be auto generated
    
    capacity - the capacity of this pool
    
    threadFactory - a factory used to create threads for all selector loops in this pool, or null to use the default factory
    
    selectorFactory - a selector factory used to create selectors for all selector loops in this pool, or null to use the default factory that will be used by this selector loop to open its selector, or null if default factory should be used
  - DefaultSelectorLoopPool
```
public DefaultSelectorLoopPool(String name,
                               int capacity)
```
    Constructs a named selector loop pool with given capacity.
    
    Parameters:
    
    name - the name of the pool or null if the name should be auto generated
    
    capacity - the capacity of this pool
  - DefaultSelectorLoopPool
```
public DefaultSelectorLoopPool(int capacity)
```
    Constructs a unnamed selector loop pool with given capacity.
    
    Parameters:
    
    capacity - the capacity of this pool
- Method Detail
  - getPool
```
public SelectorLoop[] getPool()
```
    Gets an array of all selector loops created in this pool.
    
    Returns:
    
    the array of selector loops.
  - getCapacity
```
public int getCapacity()
```
    Gets the capacity of this pool.
    
    Returns:
    
    the capacity of this pool
  - getSize
```
public int getSize()
```
    Gets the current size of this pool. It is the number of selector loops created in this pool.
    
    Returns:
    
    the current size
  - getLoop
```
public SelectorLoop getLoop(SelectableChannel channel)
```
    Gets the best selector loop from this pool that should be used to process given channel.
    
    Specified by:
    
    getLoop in interface ISelectorLoopPool
    
    Parameters:
    
    channel - the channel that needs to be processed by a selector loop form this pool
    
    Returns:
    
    the selector loop with the smallest number of the registered channels
    
    See Also:
    
    AbstractSelectorLoop#getSize
  - stop
```
public void stop()
```
    Description copied from interface: ISelectorLoopPool
    
    Gently stops all selector loops in this pool. This operation is asynchronous.
    
    Specified by:
    
    stop in interface ISelectorLoopPool
    
    See Also:
    
    InternalSelectorLoop.stop(org.snf4j.core.StoppingType)
  - quickStop
```
public void quickStop()
```
    Description copied from interface: ISelectorLoopPool
    
    Quickly stops all selector loops in this pool. This operation is asynchronous.
    
    Specified by:
    
    quickStop in interface ISelectorLoopPool
    
    See Also:
    
    InternalSelectorLoop.quickStop()
  - update
```
public void update(SelectorLoop loop,
                   int newSize,
                   int prevSize)
```
    Description copied from interface: ISelectorLoopPool
    
    Notifies the pool that given selector loop is now processing different number of channels. This method can be used to reorganize the internal structure of the pool to optimize the way the best selector loop is chosen by the getLoop method.
    
    Specified by:
    
    update in interface ISelectorLoopPool
    
    Parameters:
    
    loop - the selector loop
    
    newSize - the new number of channels processed now by the selector loop
    
    prevSize - the previous number of channels processed by the selector loop
  - join
```
public boolean join(long millis)
             throws InterruptedException
```
    Description copied from interface: ISelectorLoopPool
    
    Waits at most millis milliseconds for all selector loop's threads to die.
    
    Specified by:
    
    join in interface ISelectorLoopPool
    
    Parameters:
    
    millis - the time to wait in milliseconds
    
    Returns:
    
    true if the selector loop's thread died
    
    Throws:
    
    InterruptedException - if any thread has interrupted the current thread
  - join
```
public void join()
          throws InterruptedException
```
    Description copied from interface: ISelectorLoopPool
    
    Waits for all selector loop's threads to die.
    
    Specified by:
    
    join in interface ISelectorLoopPool
    
    Throws:
    
    InterruptedException - if any thread has interrupted the current thread

Class DefaultSelectorLoopPool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.snf4j.core.IdentifiableObject

Methods inherited from class java.lang.Object

Field Detail

pool

threadFactory

selectorFactory

size

Constructor Detail

DefaultSelectorLoopPool

DefaultSelectorLoopPool

DefaultSelectorLoopPool

Method Detail

getPool

getCapacity

getSize

getLoop

stop

quickStop

update

join

join