org.piax.util

クラス PIAXThreadPool

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

org.piax.util.PIAXThreadPool

すべての実装されたインタフェース:

Executor, ExecutorService

public class PIAXThreadPool
extends ThreadPoolExecutor

PIAXでの用途向けに、チューニング要素の多いThreadPoolExecutorを簡易的に使えるよう、機能制限したクラス。

通常の利用では、スレッドプールで起動するスレッドの最大数と、スレッド名のprefix部分を指定するだけでよい。 スレッドプールをshutdownする際にも、shutdownメソッドを呼ぶだけで済むようになっている。 executeメソッドについては、通常のメソッドの他、引数にPeerIdを指定するメソッドを用意している。 このexecuteメソッドは、スレッド名に指定されたPeerIdを付与する。 これにより、log出力の際に、どのPeerで動いたスレッドかを識別できる。

PIAXThreadPoolでは、ThreadPoolExecutorの引数として指定するtaskのキューイングに、 SynchronousQueueを使っている。これは実質的にキューイングをしないですぐにtaskをスレッド実行することを 意味している。また、拒否されたtaskに対しての振る舞いはデフォルトのAbortPolicy() にしている。 この2つの設定（SynchronousQueue＋AbortPolicy()） により、スレッドプールが最大のスレッド数に達した 時点で、新規のtaskは、拒否される。

このようにすることで、スレッドプールの動きを簡潔にし、予期せぬデッドロックを防ぐことができる。 デッドロックは、次のような場合に起こる。

一連のtask群Tの後にあるtask xが動くような状況で、Tのいくつかのtaskがxの発生により、ロック状態に入り、 xが起動または終了することでロック解除されるとする。この場合、スレッドプールは次第に飽和状態になり、 新しいtaskはキューに乗ったままになる。結果デッドロックが起こる。 例えば、互いに相手を呼び合うRPCが再帰的に何段も重なったとすると、末端のRPCがreturnするまで、 他のRPC呼び出しはブロックする。この状態で、末端のすぐにreturnするRPC呼び出しがキューにのってしまうと、 全体がデッドロックしてしまう。

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static int	CORE_POOL_SIZE thread pool内に常時起動しているスレッドの数
static int	MAX_POOL_SIZE thread pool内に起動可能なスレッドの最大数
static long	MAX_WAIT_TIME_FOR_TERMINATION thread poolの終了時にアクティブなスレッドの終了を待機する最長時間
static long	THREAD_KEEP_ALIVE_TIME アイドル状態のスレッドが終了前に新規タスクを待機する最長時間。
static String	THREAD_NAME_PREFIX スレッド名のprefix部分。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PIAXThreadPool() PIAXThreadPoolをデフォルト設定を使って、生成する。
PIAXThreadPool(int corePoolSize, int maxPoolSize, long keepAliveTime, String threadNamePrefix, int threadPriority) PIAXThreadPoolを引数の設定に従い、生成する。
PIAXThreadPool(int maxPoolSize, String threadNamePrefix) PIAXThreadPoolを最大スレッド数と、スレッド名のprefixを指定し、生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	execute(PeerId peerId, Runnable task) taskをスレッドプールのスレッドを使って実行する。
void	execute(Runnable task) taskをスレッドプールのスレッドを使って実行する。
void	shutdown() PIAXThreadPoolをshutdownする。

クラスから継承されたメソッド java.util.concurrent.ThreadPoolExecutor

afterExecute, allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdownNow, terminated, toString

クラスから継承されたメソッド java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor, submit, submit, submit

クラスから継承されたメソッド java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

CORE_POOL_SIZE

public static int CORE_POOL_SIZE

thread pool内に常時起動しているスレッドの数

MAX_POOL_SIZE

public static int MAX_POOL_SIZE

thread pool内に起動可能なスレッドの最大数

THREAD_KEEP_ALIVE_TIME

public static long THREAD_KEEP_ALIVE_TIME

アイドル状態のスレッドが終了前に新規タスクを待機する最長時間。 この時間経過すると、アイドル状態のスレッドは終了する

THREAD_NAME_PREFIX

public static String THREAD_NAME_PREFIX

スレッド名のprefix部分。この後ろにシーケンシャル番号が付く

MAX_WAIT_TIME_FOR_TERMINATION

public static final long MAX_WAIT_TIME_FOR_TERMINATION

thread poolの終了時にアクティブなスレッドの終了を待機する最長時間

関連項目:

定数フィールド値

コンストラクタの詳細

PIAXThreadPool

public PIAXThreadPool()

PIAXThreadPoolをデフォルト設定を使って、生成する。

PIAXThreadPool

public PIAXThreadPool(int maxPoolSize,
                      String threadNamePrefix)

PIAXThreadPoolを最大スレッド数と、スレッド名のprefixを指定し、生成する。

パラメータ:

maxPoolSize - 最大スレッド数

threadNamePrefix - スレッド名のprefix

PIAXThreadPool

public PIAXThreadPool(int corePoolSize,
                      int maxPoolSize,
                      long keepAliveTime,
                      String threadNamePrefix,
                      int threadPriority)

PIAXThreadPoolを引数の設定に従い、生成する。

パラメータ:

corePoolSize - 最小スレッド数

maxPoolSize - 最大スレッド数

keepAliveTime - アイドルスレッドが停止するまでの最長待ち時間

threadNamePrefix - スレッド名のprefix

threadPriority - スレッドの優先度（1から10の数字）

メソッドの詳細

execute

public void execute(PeerId peerId,
                    Runnable task)
             throws RejectedExecutionException

taskをスレッドプールのスレッドを使って実行する。

すでに、実行スレッド数が最大数に達した場合は、RejectedExecutionExceptionが発行される。 このメソッドを使って実行されたスレッドの名前にはpeerIdが付与される。

パラメータ:

peerId - スレッド名に付与するPeerId

task - 実行するRunnableオブジェクト

例外:

RejectedExecutionException - 実行スレッド数が最大数に達した場合

execute

public void execute(Runnable task)
             throws RejectedExecutionException

taskをスレッドプールのスレッドを使って実行する。

すでに、実行スレッド数が最大数に達した場合は、RejectedExecutionExceptionが発行される。 このメソッドを使った場合、実行されたスレッド名にはpeerIdは付与されない。

定義:

execute インタフェース内 Executor

オーバーライド:

execute クラス内 ThreadPoolExecutor

パラメータ:

task - 実行するRunnableオブジェクト

例外:

RejectedExecutionException - 実行スレッド数が最大数に達した場合

shutdown

public void shutdown()

PIAXThreadPoolをshutdownする。 この時点でアクティブなスレッドは、一定時間待った上で自動的に終了する。

この待ち時間は、MAX_WAIT_TIME_FOR_TERMINATIONの値を変えることで変更できる。 通常はデフォルト値のままでよい。、

定義:

shutdown インタフェース内 ExecutorService

オーバーライド:

shutdown クラス内 ThreadPoolExecutor