java.nio.channels.spi

クラス AbstractSelectableChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

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

Closeable, AutoCloseable, Channel, InterruptibleChannel

直系の既知のサブクラス:

DatagramChannel, Pipe.SinkChannel, Pipe.SourceChannel, ServerSocketChannel, SocketChannel

public abstract class AbstractSelectableChannel
extends SelectableChannel

選択可能チャネルのベース実装クラスです。

このクラスは、チャネルの登録、登録解除、クローズの処理を行うメソッドを定義します。このクラスは、このチャネルの現在のブロックモードと、現在の選択キーセットを管理します。また、SelectableChannel の仕様を実装するのに必要な同期処理をすべて実行します。このクラスに定義されている abstract protected メソッドの実装では、同じ操作を使用するほかのスレッドとの同期処理を行う必要はありません。

導入されたバージョン:

1.4

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

コンストラクタ

修飾子	コンストラクタと説明
protected	AbstractSelectableChannel(SelectorProvider provider) このクラスの新しいインスタンスを初期化します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Object	blockingLock() configureBlocking および register メソッドが同期するオブジェクトを取得します。
SelectableChannel	configureBlocking(boolean block) このチャネルのブロックモードを調整します。
protected void	implCloseChannel() 現在のチャネルをクローズします。
protected abstract void	implCloseSelectableChannel() この選択可能チャネルをクローズします。
protected abstract void	implConfigureBlocking(boolean block) このチャネルのブロックモードを調整します。
boolean	isBlocking() このチャネル上の個々の入出力操作が前の入出力操作が完了するまでブロックされるかどうかを判断します。
boolean	isRegistered() 現在このチャネルがセレクタに登録されているかどうかを判断します。
SelectionKey	keyFor(Selector sel) チャネルが指定されたセレクタに登録されていることを示すキーを取得します。
SelectorProvider	provider() このチャネルの作成元プロバイダを返します。
SelectionKey	register(Selector sel, int ops, Object att) このチャネルを指定されたセレクタに登録し、選択キーを返します。

クラス java.nio.channels.SelectableChannel から継承されたメソッド

register, validOps

クラス java.nio.channels.spi.AbstractInterruptibleChannel から継承されたメソッド

begin, close, end, isOpen

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

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

インタフェース java.nio.channels.Channel から継承されたメソッド

close, isOpen

コンストラクタの詳細

AbstractSelectableChannel

protected AbstractSelectableChannel(SelectorProvider provider)

このクラスの新しいインスタンスを初期化します。

メソッドの詳細

プロバイダ

public final SelectorProvider provider()

このチャネルの作成元プロバイダを返します。

定義:

provider、クラス: SelectableChannel

戻り値:

このチャネルの作成元プロバイダ

isRegistered

public final boolean isRegistered()

クラスからコピーされた説明: SelectableChannel

現在このチャネルがセレクタに登録されているかどうかを判断します。新しく作成されたチャネルは登録されていません。

キーの取り消しからチャネルの登録解除までの間に発生する必然的な遅延のため、キーをすべて取り消しても、しばらくの間チャネルの登録は解除されません。チャネルをクローズしたときも同様です。

定義:

isRegistered、クラス: SelectableChannel

戻り値:

このチャネルが登録されている場合にかぎり true

keyFor

public final SelectionKey keyFor(Selector sel)

クラスからコピーされた説明: SelectableChannel

チャネルが指定されたセレクタに登録されていることを示すキーを取得します。

定義:

keyFor、クラス: SelectableChannel

戻り値:

前回このチャネルを指定されたセレクタに登録したとき返されたキー。現在このチャネルが指定されたセレクタに登録されていない場合は null

register

public final SelectionKey register(Selector sel,
                    int ops,
                    Object att)
                            throws ClosedChannelException

このチャネルを指定されたセレクタに登録し、選択キーを返します。

このメソッドは、最初にこのチャネルがオープンしていることと、指定された初期対象セットが有効であることを確認します。

このチャネルが指定されたセレクタに登録されている場合、その対象セットが指定された値に設定され、登録を示す選択キーが返されます。

それ以外の場合、このチャネルは指定されたセレクタにまだ登録されていないので、適切なロックを保持した状態でセレクタの register メソッドが呼び出されます。結果として得られるキーは、返される前に、このチャネルのキーセットに追加されます。

定義:

register、クラス: SelectableChannel

パラメータ:

sel - このチャネルの登録先セレクタ

ops - 結果として得られるキーの対象セット

att - 結果として得られるキーの添付。null の場合もある

戻り値:

このチャネルが指定されたセレクタに登録されていることを示すキー

例外:

ClosedSelectorException - セレクタがクローズしている場合

IllegalBlockingModeException - このチャネルがブロックモードの場合

IllegalSelectorException - このチャネルの作成元プロバイダが指定されたセレクタの作成元プロバイダと違う場合

CancelledKeyException - チャネルは指定されたセレクタに登録されているが、対応するキーがすでに取り消されている場合

IllegalArgumentException - ops セット内のビットがこのチャネルでサポートされる操作に対応していない場合 (set & ~validOps() != 0 の場合)

ClosedChannelException - このチャネルがクローズしている場合

implCloseChannel

protected final void implCloseChannel()
                               throws IOException

現在のチャネルをクローズします。

このメソッドは、AbstractInterruptibleChannel クラスで指定されており、close メソッドによって呼び出されたあと、このチャネルを実際にクローズする処理を行うために implCloseSelectableChannel メソッドを呼び出します。次に、このチャネルのキーをすべて取り消します。

定義:

implCloseChannel、クラス: AbstractInterruptibleChannel

例外:

IOException - チャネルのクローズ中に入出力エラーが発生した場合

implCloseSelectableChannel

protected abstract void implCloseSelectableChannel()
                                            throws IOException

この選択可能チャネルをクローズします。

このメソッドは、チャネルをクローズする実際の処理を実行するために close メソッドによって呼び出されます。このメソッドは、チャネルがまだクローズしていない場合にのみ呼び出され、2 回以上呼び出されることはありません。

このメソッドの実装は、このチャネルに対する入出力操作の途中でブロックされるその他のスレッドを、例外をスローするか、通常の方法を使ってただちに終了させることになっています。

例外:

IOException

isBlocking

public final boolean isBlocking()

クラスからコピーされた説明: SelectableChannel

このチャネル上の個々の入出力操作が前の入出力操作が完了するまでブロックされるかどうかを判断します。新しく作成されたチャネルは常にブロックモードです。

このチャネルがクローズしている場合、このメソッドの戻り値は特定されません。

定義:

isBlocking、クラス: SelectableChannel

戻り値:

このチャネルがブロックモードである場合にかぎり true

blockingLock

public final Object blockingLock()

クラスからコピーされた説明: SelectableChannel

configureBlocking および register メソッドが同期するオブジェクトを取得します。この機能は、特定のブロックモードを短時間保持する必要があるアダプタを実装する場合に便利です。

定義:

blockingLock、クラス: SelectableChannel

戻り値:

ブロックモードのロックオブジェクト

configureBlocking

public final SelectableChannel configureBlocking(boolean block)
                                          throws IOException

このチャネルのブロックモードを調整します。

指定されたブロックモードが現在のブロックモードと異なっている場合、このメソッドは、適切なロックを保持した状態で implConfigureBlocking メソッドを呼び出してモードを変更します。

定義:

configureBlocking、クラス: SelectableChannel

パラメータ:

block - true の場合はこのチャネルがブロックモードになり、false の場合は非ブロックモードになる

戻り値:

この選択可能チャネル

例外:

ClosedChannelException - このチャネルがクローズしている場合

IOException - 入出力エラーが発生した場合

implConfigureBlocking

protected abstract void implConfigureBlocking(boolean block)
                                       throws IOException

このチャネルのブロックモードを調整します。

このメソッドは、ブロックモードを変更する実際の処理を実行するために configureBlocking メソッドによって呼び出されます。このメソッドは、新しいモードが現在のモードと異なっている場合に限り呼び出されます。

例外:

IOException - 入出力エラーが発生した場合