java.nio.channels

クラス MembershipKey

java.lang.Object

java.nio.channels.MembershipKey

public abstract class MembershipKey
extends Object

IP (Internet Protocol) マルチキャストグループのメンバーシップを表すトークン。

メンバーシップキーは、グループに送信されるすべてのデータグラムを受信するためのメンバーシップを表すか、特定のソースアドレスからのデータグラムのみを受信するメンバーシップを表すことを意味するソース固有です。メンバーシップキーがソース固有かどうかは、sourceAddress メソッドの呼び出しによって判断できます。

メンバーシップキーは作成時に有効であり、drop メソッドの呼び出しによってメンバーシップがドロップされるか、チャネルがクローズされるまで有効なままです。メンバーシップキーの有効性は、isValid メソッドを呼び出すことによってテストできます。

メンバーシップキーがソース固有ではなく、基本となるオペレーティングシステムでソースのフィルタリングがサポートされる場合、block メソッドと unblock メソッドを使用して、特定のソースアドレスからのマルチキャストデータグラムをブロックまたはブロック解除することができます。

導入されたバージョン:

1.7

関連項目:

MulticastChannel

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

コンストラクタ

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

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract MembershipKey	block(InetAddress source) 指定されたソースアドレスからマルチキャストデータグラムをブロックします。
abstract MulticastChannel	channel() 作成されたこのメンバーシップキーのチャネルを返します。
abstract void	drop() メンバーシップをドロップします。
abstract InetAddress	group() 作成されたこのメンバーシップキーのマルチキャストグループを返します。
abstract boolean	isValid() このメンバーシップが有効であるかどうかを判断します。
abstract NetworkInterface	networkInterface() 作成されたこのメンバーシップキーのネットワークインタフェースを返します。
abstract InetAddress	sourceAddress() このメンバーシップキーがソース固有である場合はソースアドレスを返し、このメンバーシップがソース固有でない場合は null を返します。
abstract MembershipKey	unblock(InetAddress source) 指定されたソースアドレスから、block メソッドを使用して以前にブロックされたマルチキャストデータグラムをブロック解除します。

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

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

コンストラクタの詳細

MembershipKey

protected MembershipKey()

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

メソッドの詳細

isValid

public abstract boolean isValid()

このメンバーシップが有効であるかどうかを判断します。

マルチキャストグループメンバーシップは作成時に有効であり、drop メソッドの呼び出しによってメンバーシップがドロップされるか、チャネルがクローズされるまで有効なままです。

戻り値:

メンバーシップキーが有効な場合は true、それ以外の場合は false

drop

public abstract void drop()

メンバーシップをドロップします。

メンバーシップキーがすべてのデータグラムを受信するためのメンバーシップを表す場合、メンバーシップはドロップされ、チャネルはグループに送信されるデータグラムを受信しなくなります。メンバーシップキーがソース固有の場合、チャネルは、そのソースアドレスからグループに送信されるデータグラムを受信しなくなります。

メンバーシップは、ドロップされたあとでも、グループに送信されるデータグラムを受信することがあります。これは、データグラムがソケットの受信バッファーに受信されるのを待機している場合に発生します。メンバーシップのドロップ後に、チャネルはグループに再度参加することがあり、この場合は新しいメンバーシップキーが返されます。

返されたときに、このメンバーシップオブジェクトは無効になります。マルチキャストグループメンバーシップがすでに無効になっている場合、このメソッドを呼び出しても何の影響もありません。いったん無効になったマルチキャストグループメンバーシップは、永久に無効なままです。

block

public abstract MembershipKey block(InetAddress source)
                             throws IOException

指定されたソースアドレスからマルチキャストデータグラムをブロックします。

このメンバーシップキーがソース固有ではなく、基本となるオペレーティングシステムでソースのフィルタリングがサポートされる場合、このメソッドは、指定したソースアドレスからのマルチキャストデータグラムをブロックします。指定したソースアドレスがすでにブロックされている場合、このメソッドは何の影響もありません。ソースアドレスのブロック後でも、そのソースからデータグラムを受信することがあります。これは、データグラムがソケットの受信バッファーに受信されるのを待機している場合に発生します。

パラメータ:

source - ブロックするソースアドレス

戻り値:

このメンバーシップキー

例外:

IllegalArgumentException - source パラメータがユニキャストアドレスではないか、マルチキャストグループと同じアドレスタイプではない場合

IllegalStateException - このメンバーシップキーがソース固有であるか、無効になっている場合

UnsupportedOperationException - 基本となるオペレーティングシステムでソースのフィルタリングがサポートされない場合

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

unblock

public abstract MembershipKey unblock(InetAddress source)

指定されたソースアドレスから、block メソッドを使用して以前にブロックされたマルチキャストデータグラムをブロック解除します。

パラメータ:

source - ブロック解除するソースアドレス

戻り値:

このメンバーシップキー

例外:

IllegalStateException - 指定したソースアドレスが現在ブロックされていないか、メンバーシップキーが無効になっている場合

channel

public abstract MulticastChannel channel()

作成されたこのメンバーシップキーのチャネルを返します。このメソッドは、メンバーシップが無効になったあともチャネルを返します。

戻り値:

そのチャネル

group

public abstract InetAddress group()

作成されたこのメンバーシップキーのマルチキャストグループを返します。このメソッドは、メンバーシップが無効になったあともグループを返します。

戻り値:

そのマルチキャストグループ

networkInterface

public abstract NetworkInterface networkInterface()

作成されたこのメンバーシップキーのネットワークインタフェースを返します。このメソッドは、メンバーシップが無効になったあともネットワークインタフェースを返します。

戻り値:

そのネットワークインタフェース

sourceAddress

public abstract InetAddress sourceAddress()

このメンバーシップキーがソース固有である場合はソースアドレスを返し、このメンバーシップがソース固有でない場合は null を返します。

戻り値:

このメンバーシップキーがソース固有の場合はソースアドレス、それ以外の場合は null