- すべてのスーパー・インタフェース:
AutoCloseable
,Channel
,Closeable
- 既知のすべてのサブインタフェース:
MulticastChannel
- 既知のすべての実装クラス:
AsynchronousServerSocketChannel
,AsynchronousSocketChannel
,DatagramChannel
,ServerSocketChannel
,SocketChannel
public interface NetworkChannel extends Channel
ネットワーク・ソケットへのチャネルです。
このインタフェースを実装するチャネルは、ネットワーク・ソケットへのチャネルです。 bind
メソッドは、ソケットをローカル・アドレス
にバインドするために使用され、getLocalAddress
メソッドは、ソケットのバインド先のアドレスを返し、setOption
メソッドとgetOption
メソッドは、ソケット・オプションを設定して照会するために使用されます。 このインタフェースの実装では、サポートされるソケット・オプションを指定してください。
bind
メソッドとsetOption
メソッドのうち戻り値を返さないものは、自身を呼び出したネットワーク・チャネルを返します。 これを応用して、メソッド呼出しを連鎖させることができます。 このインタフェースの実装は、この実装クラスのメソッド呼出しを連鎖できるように、戻り型を特殊化することをお薦めします。
- 導入されたバージョン:
- 1.7
-
メソッドのサマリー
修飾子と型メソッド説明bind
(SocketAddress local) チャネルのソケットをローカル・アドレスにバインドします。このチャネルのソケットがバインドされているソケット・アドレスを返します。<T> T
getOption
(SocketOption<T> name) ソケット・オプションの値を返します。<T> NetworkChannel
setOption
(SocketOption<T> name, T value) ソケット・オプションの値を設定します。Set<SocketOption<?>>
このチャネルがサポートするソケット・オプションのセットを返します。
-
メソッドの詳細
-
bind
チャネルのソケットをローカル・アドレスにバインドします。このメソッドは、ソケットとローカル・アドレスとの間の関連付けを確立するために使用されます。 関連付けが確立されると、ソケットはチャネルが閉じられるまでバインドされたままになります。
local
パラメータの値がnull
の場合、ソケットは自動的に割り当てられるアドレスにバインドされます。- パラメータ:
local
- ソケットのバインド先のアドレス、または自動的に割り当てられるソケット・アドレスにソケットをバインドする場合はnull
- 戻り値:
- このチャネル
- 例外:
AlreadyBoundException
- ソケットがすでにバインドされている場合UnsupportedAddressTypeException
- 指定されたアドレスのタイプがサポート対象外の場合ClosedChannelException
- チャネルがクローズしている場合IOException
- その他の入出力エラーが発生した場合SecurityException
- セキュリティ・マネージャがインストールされ、それが未指定のアクセス権を拒否する場合。 このインタフェースの実装は、必要なアクセス権を指定するべきです。- 関連項目:
-
getLocalAddress
SocketAddress getLocalAddress() throws IOExceptionこのチャネルのソケットがバインドされているソケット・アドレスを返します。チャネルがInternet Protocolソケット・アドレスに
バインド
されている場合は、このメソッドからの戻り値の型はInetSocketAddress
です。- 戻り値:
- ソケットのバインド先のソケット・アドレス、またはチャネルのソケットがバインドされていない場合は
null
- 例外:
ClosedChannelException
- チャネルがクローズしている場合IOException
- 入出力エラーが発生した場合
-
setOption
<T> NetworkChannel setOption(SocketOption<T> name, T value) throws IOException ソケット・オプションの値を設定します。- 型パラメータ:
T
- ソケット・オプション値のタイプ- パラメータ:
name
- ソケット・オプションvalue
- ソケット・オプションの値。 一部のソケット・オプションに対しては、null
の値が有効な値である場合があります。- 戻り値:
- このチャネル
- 例外:
UnsupportedOperationException
- チャネルがソケット・オプションをサポートしていない場合IllegalArgumentException
- 値がこのソケット・オプションに対して有効な値でない場合ClosedChannelException
- このチャネルがクローズしている場合IOException
- 入出力エラーが発生した場合- 関連項目:
-
getOption
<T> T getOption(SocketOption<T> name) throws IOException ソケット・オプションの値を返します。- 型パラメータ:
T
- ソケット・オプション値のタイプ- パラメータ:
name
- ソケット・オプション- 戻り値:
- ソケット・オプションの値。 一部のソケット・オプションに対しては、
null
の値が有効な値である場合があります。 - 例外:
UnsupportedOperationException
- チャネルがソケット・オプションをサポートしていない場合ClosedChannelException
- このチャネルがクローズしている場合IOException
- 入出力エラーが発生した場合- 関連項目:
-
supportedOptions
Set<SocketOption<?>> supportedOptions()このチャネルがサポートするソケット・オプションのセットを返します。このメソッドは、チャネルが閉じられたあとでも引き続きオプションのセットを返します。
- 戻り値:
- このチャネルでサポートされるソケット・オプションのセット
-