java.nio.channels

インタフェース NetworkChannel

すべてのスーパーインタフェース:

AutoCloseable, Channel, Closeable

既知のすべてのサブインタフェース:

MulticastChannel

既知のすべての実装クラス:

AsynchronousServerSocketChannel, AsynchronousSocketChannel, DatagramChannel, ServerSocketChannel, SocketChannel

public interface NetworkChannel
extends Channel

ネットワークソケットへのチャネル。

このインタフェースを実装するチャネルは、ネットワークソケットへのチャネルです。bind メソッドは、ソケットをローカルアドレスにバインドするために使用され、getLocalAddress メソッドは、ソケットのバインド先のアドレスを返し、setOption メソッドと getOption メソッドは、ソケットオプションを設定して照会するために使用されます。このインタフェースの実装では、サポートされるソケットオプションを指定してください。

bind メソッドと setOption メソッドのうち戻り値を返さないものは、自身を呼び出したネットワークチャネルを返します。これを応用して、メソッド呼び出しを連鎖させることができます。このインタフェースの実装は、この実装クラスのメソッド呼び出しを連鎖できるように、戻り型を特殊化することをお勧めします。

導入されたバージョン:

1.7

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
NetworkChannel	bind(SocketAddress local) チャネルのソケットをローカルアドレスにバインドします。
SocketAddress	getLocalAddress() このチャネルのソケットがバインドされているソケットのアドレスを返します。ソケットがバインドされていない場合は null を返します。
<T> T	getOption(SocketOption<T> name) ソケットオプションの値を返します。
<T> NetworkChannel	setOption(SocketOption<T> name, T value) ソケットオプションの値を設定します。
Set<SocketOption<?>>	supportedOptions() このチャネルがサポートするソケットオプションのセットを返します。

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

close, isOpen

メソッドの詳細

bind

NetworkChannel bind(SocketAddress local)
                    throws IOException

チャネルのソケットをローカルアドレスにバインドします。

このメソッドは、ソケットとローカルアドレスとの間の関連付けを確立するために使用されます。関連付けが確立されると、ソケットはチャネルが閉じられるまでバインドされたままになります。local パラメータの値が null の場合、ソケットは自動的に割り当てられるアドレスにバインドされます。

パラメータ:

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

戻り値:

このチャネル

例外:

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

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

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

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

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

関連項目:

getLocalAddress()

getLocalAddress

SocketAddress getLocalAddress()
                              throws IOException

このチャネルのソケットがバインドされているソケットのアドレスを返します。ソケットがバインドされていない場合は null を返します。

チャネルが IP (Internet Protocol) ソケットアドレスにバインドされている場合は、このメソッドからの戻り値の型は InetSocketAddress です。

戻り値:

ソケットのバインド先のソケットアドレス、またはチャネルのソケットがバインドされていない場合は null

例外:

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

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

setOption

<T> NetworkChannel setOption(SocketOption<T> name,
                           T value)
                         throws IOException

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

パラメータ:

name - ソケットオプション

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

戻り値:

このチャネル

例外:

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

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

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

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

関連項目:

StandardSocketOptions

getOption

<T> T getOption(SocketOption<T> name)
            throws IOException

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

パラメータ:

name - ソケットオプション

戻り値:

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

例外:

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

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

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

関連項目:

StandardSocketOptions

supportedOptions

Set<SocketOption<?>> supportedOptions()

このチャネルがサポートするソケットオプションのセットを返します。

このメソッドは、チャネルが閉じられたあとでも引き続きオプションのセットを返します。

戻り値:

このチャネルでサポートされるソケットオプションのセット