java.nio.channels

クラス ServerSocketChannel

java.lang.Object

java.nio.channels.spi.AbstractInterruptibleChannel

java.nio.channels.SelectableChannel

java.nio.channels.spi.AbstractSelectableChannel

java.nio.channels.ServerSocketChannel

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

Closeable, AutoCloseable, Channel, InterruptibleChannel, NetworkChannel

public abstract class ServerSocketChannel
extends AbstractSelectableChannel
implements NetworkChannel

ストリーム型リスニングソケット用の選択可能なチャネルです。

このクラスの open メソッドを呼び出すと、サーバーソケットチャネルが作成されます。任意の既存の ServerSocket のチャネルを作成することはできません。新しく作成されたサーバーソケットチャネルはオープンですが、未バインドです。バインドされていないサーバーソケットチャネルの accept メソッドを呼び出そうとすると、NotYetBoundException がスローされます。サーバーソケットチャネルは、このクラスによって定義される bind メソッドの 1 つを呼び出すことによってバインドできます。

ソケットオプションは setOption メソッドを使用して構成されます。サーバーソケットチャネルでは次のオプションがサポートされます。

オプション名	説明
SO_RCVBUF	ソケット受信バッファーのサイズ
SO_REUSEADDR	アドレスを再利用します

追加 (実装固有) のオプションをサポートできる場合もあります。

サーバーソケットチャネルは、複数の並行スレッドで安全に使用できます。

導入されたバージョン:

1.4

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

コンストラクタ

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

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract SocketChannel	accept() このチャネルのソケットに対する接続を受け付けます。
ServerSocketChannel	bind(SocketAddress local) チャネルのソケットをローカルアドレスにバインドし、接続を待機するようソケットを構成します。
abstract ServerSocketChannel	bind(SocketAddress local, int backlog) チャネルのソケットをローカルアドレスにバインドし、接続を待機するようソケットを構成します。
static ServerSocketChannel	open() サーバーソケットチャネルをオープンします。
abstract <T> ServerSocketChannel	setOption(SocketOption<T> name, T value) ソケットオプションの値を設定します。
abstract ServerSocket	socket() このチャネルに関連したサーバーソケットを取得します。
int	validOps() このチャネルのサポートされている操作を識別する操作セットを返します。

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

blockingLock, configureBlocking, implCloseChannel, implCloseSelectableChannel, implConfigureBlocking, isBlocking, isRegistered, keyFor, provider, register

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

register

クラス 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.NetworkChannel から継承されたメソッド

getLocalAddress, getOption, supportedOptions

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

close, isOpen

コンストラクタの詳細

ServerSocketChannel

protected ServerSocketChannel(SelectorProvider provider)

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

メソッドの詳細

open

public static ServerSocketChannel open()
                                throws IOException

サーバーソケットチャネルをオープンします。

システム全体のデフォルト SelectorProvider オブジェクトの openServerSocketChannel メソッドを呼び出すことで、新しいチャネルが作成されます。

新しいチャネルのソケットは、初期状態では未バインドです。ソケットの bind メソッドの 1 つを使って特定のアドレスにバインドしないと、接続は受け付けられません。

戻り値:

新しいソケットチャネル

例外:

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

validOps

public final int validOps()

このチャネルのサポートされている操作を識別する操作セットを返します。

サーバーソケットチャネルは、新しい接続の受け付けだけをサポートします。したがって、このメソッドは SelectionKey.OP_ACCEPT を返します。

定義:

validOps、クラス: SelectableChannel

戻り値:

有効な操作セット

bind

public final ServerSocketChannel bind(SocketAddress local)
                               throws IOException

チャネルのソケットをローカルアドレスにバインドし、接続を待機するようソケットを構成します。

このメソッドの呼び出しは次と同等です。

 bind(local, 0);
 

定義:

bind、インタフェース: NetworkChannel

パラメータ:

local - ソケットのバインド先のローカルアドレス、または自動的に割り当てられるソケットアドレスにバインドする場合は null

戻り値:

このチャネル

例外:

AlreadyBoundException - ソケットがすでにバインドされている場合

UnsupportedAddressTypeException - 指定されたアドレスのタイプがサポート対象外の場合

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

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

SecurityException - セキュリティーマネージャーがインストールされていて、その checkListen メソッドが操作を拒否した場合

導入されたバージョン:

1.7

関連項目:

NetworkChannel.getLocalAddress()

bind

public abstract ServerSocketChannel bind(SocketAddress local,
                       int backlog)
                                  throws IOException

チャネルのソケットをローカルアドレスにバインドし、接続を待機するようソケットを構成します。

このメソッドは、ソケットとローカルアドレスとの間の関連付けを確立するために使用されます。関連付けが確立されると、ソケットはチャネルが閉じられるまでバインドされたままになります。

backlog パラメータは、ソケットの保留されている接続の最大数です。正確なセマンティクスは実装に固有です。たとえば、実装が最大長を規定していたり、パラメータをまったく無視したりする場合があります。backlog パラメータの値が 0 または負の値の場合、実装固有のデフォルトが使用されます。

パラメータ:

local - ソケットのバインド先のアドレス、または自動的に割り当てられるソケットアドレスにバインドする場合は null

backlog - 保留されている接続の最大数。

戻り値:

このチャネル

例外:

AlreadyBoundException - ソケットがすでにバインドされている場合

UnsupportedAddressTypeException - 指定されたアドレスのタイプがサポート対象外の場合

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

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

SecurityException - セキュリティーマネージャーがインストールされていて、その checkListen メソッドが操作を拒否した場合

導入されたバージョン:

1.7

setOption

public abstract <T> ServerSocketChannel setOption(SocketOption<T> name,
                                T value)
                                       throws IOException

インタフェースからコピーされた説明: NetworkChannel

ソケットオプションの値を設定します。

定義:

setOption、インタフェース: NetworkChannel

パラメータ:

name - ソケットオプション

value - ソケットオプションの値。一部のソケットオプションに対しては、null の値が有効な値である場合があります。

戻り値:

このチャネル

例外:

UnsupportedOperationException - チャネルがソケットオプションをサポートしていない場合

IllegalArgumentException - 値がこのソケットオプションに対して有効な値でない場合

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

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

導入されたバージョン:

1.7

関連項目:

StandardSocketOptions

socket

public abstract ServerSocket socket()

このチャネルに関連したサーバーソケットを取得します。

返されるオブジェクトは、ServerSocket クラスで宣言されていない public メソッドは宣言しません。

戻り値:

このチャネルに関連したサーバーソケット

accept

public abstract SocketChannel accept()
                              throws IOException

このチャネルのソケットに対する接続を受け付けます。

このチャネルが非ブロックモードの場合、保留されている接続がなければ、このメソッドはただちに null を返します。それ以外の場合、新しい接続が利用可能になるか、入出力エラーが発生するまで無期限にブロックされます。

このメソッドによって返されるソケットチャネルは、このチャネルがブロックモードであってもそうでなくてもブロックモードになります。

このメソッドは、ServerSocket クラスの accept メソッドとまったく同じセキュリティーチェックを行います。セキュリティーマネージャーがインストールされている場合、このメソッドは、新しい各接続のリモートエンドポイントのアドレスとポート番号がセキュリティーマネージャーの checkAccept メソッドによって許可されていることを確認します。

戻り値:

新しい接続のソケットチャネル。このチャネルが非ブロックモードで、受け付け可能な接続が存在しない場合は null

例外:

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

AsynchronousCloseException - 受け付け操作の進行中に、別のスレッドによってこのチャネルがクローズされた場合

ClosedByInterruptException - 受け付け操作の進行中に、現在のスレッドに対して別のスレッドから割り込みがあったためにチャネルがクローズし、現在のスレッドの割り込みステータスが設定された場合

NotYetBoundException - このチャネルのソケットが未バインドの場合

SecurityException - セキュリティーマネージャーがインストールされていて、新しい接続のリモートエンドポイントへのアクセスが許可されていない場合

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