java.nio.channels

クラス AsynchronousServerSocketChannel

java.lang.Object

java.nio.channels.AsynchronousServerSocketChannel

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

Closeable, AutoCloseable, AsynchronousChannel, Channel, NetworkChannel

public abstract class AsynchronousServerSocketChannel
extends Object
implements AsynchronousChannel, NetworkChannel

ストリーム型リスニングソケット用の非同期チャネルです。

このクラスの open メソッドを呼び出すと、非同期のサーバーソケットチャネルが作成されます。新しく作成された非同期のサーバーソケットチャネルはオープンですが、未バインドです。これは、ローカルアドレスにバインドでき、bind メソッドを呼び出すことで接続を待機するよう構成できます。バインド後に、accept メソッドを使用して、チャネルのソケットへの接続の受け付けが開始されます。バインドされていないチャネルの accept メソッドを呼び出そうとすると、NotYetBoundException がスローされます。

このタイプのチャネルは複数の並行スレッドで安全に使用できますが、最大で 1 つの受け付け操作が常に未処理になる可能性があります。前の受け付け操作が終了する前にスレッドが受け付け操作を開始すると、AcceptPendingException がスローされます。

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

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

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

使用例:

  final AsynchronousServerSocketChannel listener =
      AsynchronousServerSocketChannel.open().bind(new InetSocketAddress(5000));

  listener.accept(null, new CompletionHandler<AsynchronousSocketChannel,Void>() {
      public void completed(AsynchronousSocketChannel ch, Void att) {
          // accept the next connection
          listener.accept(null, this);

          // handle this connection
          handle(ch);
      }
      public void failed(Throwable exc, Void att) {
          ...
      }
  });
 

導入されたバージョン:

1.7

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

コンストラクタ

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

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract Future<AsynchronousSocketChannel>	accept() 接続を受け入れます。
abstract <A> void	accept(A attachment, CompletionHandler<AsynchronousSocketChannel,? super A> handler) 接続を受け入れます。
AsynchronousServerSocketChannel	bind(SocketAddress local) チャネルのソケットをローカルアドレスにバインドし、接続を待機するようソケットを構成します。
abstract AsynchronousServerSocketChannel	bind(SocketAddress local, int backlog) チャネルのソケットをローカルアドレスにバインドし、接続を待機するようソケットを構成します。
static AsynchronousServerSocketChannel	open() 非同期のサーバーソケットチャネルを開きます。
static AsynchronousServerSocketChannel	open(AsynchronousChannelGroup group) 非同期のサーバーソケットチャネルを開きます。
AsynchronousChannelProvider	provider() このチャネルの作成元プロバイダを返します。
abstract <T> AsynchronousServerSocketChannel	setOption(SocketOption<T> name, T value) ソケットオプションの値を設定します。

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

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

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

close

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

getLocalAddress, getOption, supportedOptions

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

isOpen

コンストラクタの詳細

AsynchronousServerSocketChannel

protected AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)

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

メソッドの詳細

プロバイダ

public final AsynchronousChannelProvider provider()

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

open

public static AsynchronousServerSocketChannel open(AsynchronousChannelGroup group)
                                            throws IOException

非同期のサーバーソケットチャネルを開きます。

指定したグループを作成した AsynchronousChannelProvider オブジェクトで openAsynchronousServerSocketChannel メソッドを呼び出すことで、新しいチャネルが作成されます。group パラメータが null の場合、結果のチャネルは、システム全体のデフォルトプロバイダによって作成され、デフォルトグループにバインドされます。

パラメータ:

group - 新たに構築されたチャネルのバインド先のグループ、またはデフォルトグループの場合は null

戻り値:

新しい非同期サーバーソケットチャネル

例外:

ShutdownChannelGroupException - チャネルグループがシャットダウンしている場合

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

open

public static AsynchronousServerSocketChannel open()
                                            throws IOException

非同期のサーバーソケットチャネルを開きます。

このメソッドは、デフォルトグループにバインドされた非同期のサーバーソケットチャネルを返します。このメソッドの呼び出しは次の式の評価と等価です。

 open((AsynchronousChannelGroup)null);
 

戻り値:

新しい非同期サーバーソケットチャネル

例外:

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

bind

public final AsynchronousServerSocketChannel bind(SocketAddress local)
                                           throws IOException

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

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

 bind(local, 0);
 

定義:

bind、インタフェース: NetworkChannel

パラメータ:

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

戻り値:

このチャネル

例外:

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

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

SecurityException - セキュリティーマネージャーがインストールされ、それが未指定のアクセス権を拒否する場合。このインタフェースの実装は、必要なアクセス権を指定するべきです。

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

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

関連項目:

NetworkChannel.getLocalAddress()

bind

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

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

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

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

パラメータ:

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

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

戻り値:

このチャネル

例外:

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

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

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

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

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

setOption

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

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

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

定義:

setOption、インタフェース: NetworkChannel

パラメータ:

name - ソケットオプション

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

戻り値:

このチャネル

例外:

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

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

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

関連項目:

StandardSocketOptions

accept

public abstract <A> void accept(A attachment,
              CompletionHandler<AsynchronousSocketChannel,? super A> handler)

接続を受け入れます。

このメソッドは、このチャネルのソケットに対する接続を受け付けるための非同期操作を開始します。handler パラメータは、接続が受け付けられた (または操作が失敗した) ときに呼び出される終了ハンドラです。終了ハンドラに渡される結果は、新しい接続への AsynchronousSocketChannel です。

新しい接続が受け付けられると、結果の AsynchronousSocketChannel は、このチャネルと同じ AsynchronousChannelGroup にバインドされます。グループがシャットダウンしている場合に接続が受け付けられると、接続は閉じられ、操作は IOException で終了して、ShutdownChannelGroupException がスローされます。

新しい接続の並行処理を可能にするために、新しい接続がすぐに受け付けられたときに、終了ハンドラは開始スレッドによって直接呼び出されません (「スレッド」を参照)。

セキュリティーマネージャーがインストールされている場合、接続のリモートエンドポイントのアドレスとポート番号がセキュリティーマネージャーの checkAccept メソッドによって許可されていることが検証されます。アクセス権のチェックは、このメソッドの呼び出し側コンテキストによって制限される権限を使用して実行されます。アクセス権のチェックが失敗した場合、接続は閉じられ、操作は SecurityException で終了します。

パラメータ:

attachment - 入出力操作に接続されるオブジェクト。null も可

handler - 結果を消費するためのハンドラ

例外:

AcceptPendingException - このチャネルで受け付け操作がすでに進行中である場合

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

ShutdownChannelGroupException - チャネルグループが終了している場合

accept

public abstract Future<AsynchronousSocketChannel> accept()

接続を受け入れます。

このメソッドは、このチャネルのソケットに対する接続を受け付けるための非同期操作を開始します。このメソッドは、accept(Object, CompletionHandler) メソッドとまったく同じように動作します。ただし、終了ハンドラを指定する代わりに、このメソッドは保留状態の結果を表す Future を返します。Future の get メソッドは、正常に完了すると新しい接続への AsynchronousSocketChannel を返します。

戻り値:

保留されている結果を表す Future オブジェクト

例外:

AcceptPendingException - このチャネルで受け付け操作がすでに進行中である場合

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