com.JRcServer.commons.net
クラス MultiCastV4

java.lang.Object
  上位を拡張 com.JRcServer.commons.net.MultiCastV4
すべての実装されたインタフェース:
BaseMultiCast

public class MultiCastV4
extends java.lang.Object
implements BaseMultiCast

マルチキャストIPV4版.

マルチキャストUDPプロトコルIPV4版のオブジェクトです.

導入されたバージョン:
JRcCommons 1.00
バージョン:
1.00, 2005/02/07
作成者:
Masahito Suzuki

フィールドの概要
 
インタフェース com.JRcServer.commons.net.BaseMultiCast から継承されたフィールド
BUFFER, DEF_BUFFER, DEF_PORT, DEF_TTL
 
コンストラクタの概要
MultiCastV4()
          コンストラクタ.
 
メソッドの概要
 void close()
          クローズ処理.
 int getBuffer()
          設定バッファ長を取得.
 int getGroupID()
          グループIDを取得.
 java.net.InetAddress getInterface()
          利用インターフェイスを取得.
 ConnectAddress getLocal()
          ローカルアドレスを取得.
 void getLocal(ConnectAddress addr)
          ローカルアドレスを取得.
 java.net.InetAddress getLocalAddress()
          ローカルアドレス情報を取得.
 int getLocalPort()
          ローカルポート番号を取得.
 int getTTL()
          設定されている有効期限を取得.
 boolean isGroup()
          グループ参加チェック.
 boolean isOpen()
          オープンチェック.
 void joinGroup(int id)
          グループに参加.
 void joinGroup(int id, int ttl)
          グループに参加.
 void leaveGroup()
          現在参加しているグループから離脱.
 void open()
          オープン処理.
 void open(int buf)
          オープン処理.
 void open(int port, int buf)
          オープン処理.
 void open(int port, int buf, byte defTTL)
          オープン処理.
 int receive(byte[] out, ConnectAddress addr)
          データ受信.
 int receive(byte[] out, ConnectAddress addr, int timeout)
          データ受信.
 byte[] receive(ConnectAddress addr)
          データ受信.
 byte[] receive(ConnectAddress addr, int timeout)
          データ受信.
 void send(byte[] binary)
          データ送信.
 void send(byte[] binary, byte ttl)
          データ送信.
 void send(int id, int port, byte[] binary)
          データ送信.
 void send(int id, int port, byte[] binary, byte ttl)
          データ送信.
 void setInterface(java.net.InetAddress inf)
          利用インターフェイスを設定.
 void setTTL(int ttl)
          有効期限を設定.
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MultiCastV4

public MultiCastV4()
コンストラクタ.

メソッドの詳細

open

public final void open()
                throws NotBindException
オープン処理.

ポート番号をデフォルトポート番号で指定して、オープンします.

定義:
インタフェース BaseMultiCast 内の open
例外:
NotBindException - バインド失敗.

open

public final void open(int buf)
                throws InputException,
                       NotBindException
オープン処理.

ポート番号をデフォルトポート番号で指定して、オープンします.

定義:
インタフェース BaseMultiCast 内の open
パラメータ:
buf - 送受信バッファ長を設定します.
例外:
InputException - 入力例外.
NotBindException - バインド失敗.

open

public final void open(int port,
                       int buf)
                throws InputException,
                       NotBindException
オープン処理.

ポート番号を指定して、オープンします.

定義:
インタフェース BaseMultiCast 内の open
パラメータ:
port - オープンポート番号を設定します.
buf - 送受信バッファ長を設定します.
例外:
InputException - 入力例外.
NotBindException - バインド失敗.

open

public final void open(int port,
                       int buf,
                       byte defTTL)
                throws InputException,
                       NotBindException
オープン処理.

ポート番号を指定して、オープンします.

定義:
インタフェース BaseMultiCast 内の open
パラメータ:
port - オープンポート番号を設定します.
buf - 送受信バッファ長を設定します.
defTTL - デフォルトのTTL(TimeToLive)を設定します.
例外:
InputException - 入力例外.
NotBindException - バインド失敗.

close

public final void close()
クローズ処理.

クローズ処理を行います.

定義:
インタフェース BaseMultiCast 内の close

setInterface

public final void setInterface(java.net.InetAddress inf)
                        throws InputException,
                               NotInterfaceException
利用インターフェイスを設定.

マルチキャストを行う利用インターフェイスを設定します.
また、ここで言うインターフェイスは接続先のネットワークを意味する ものであり、例えばLANが2つあった時の利用先を指定する場合に 利用します.

定義:
インタフェース BaseMultiCast 内の setInterface
パラメータ:
inf - 対象のインターフェイス先を設定します.
例外:
InputException - 入力例外.
NotInterfaceException - インターフェイス非存在例外.

joinGroup

public final void joinGroup(int id)
                     throws InputException
グループに参加.

対象IDのグループに参加します.

パラメータ:
id - グループ参加対象のIDを指定します.
例外:
InputException - 入力例外.

joinGroup

public final void joinGroup(int id,
                            int ttl)
                     throws InputException
グループに参加.

対象IDのグループに参加します.

パラメータ:
id - グループ参加対象のIDを指定します.
ttl - 対象グループの有効期限を設定します.
例外:
InputException - 入力例外.

leaveGroup

public final void leaveGroup()
現在参加しているグループから離脱.

現在参加しているグループから離脱します.

定義:
インタフェース BaseMultiCast 内の leaveGroup

send

public final void send(byte[] binary)
                throws InputException,
                       UndefineBindException
データ送信.

対象のデータを送信します.

定義:
インタフェース BaseMultiCast 内の send
パラメータ:
binary - 送信対象のデータを設定します.
例外:
InputException - 入力例外.
UndefineBindException - 未バインド例外.

send

public final void send(byte[] binary,
                       byte ttl)
                throws InputException,
                       UndefineBindException
データ送信.

対象のデータを送信します.

定義:
インタフェース BaseMultiCast 内の send
パラメータ:
binary - 送信対象のデータを設定します.
ttl - マルチキャストパケット有効期間を設定します.
例外:
InputException - 入力例外.
UndefineBindException - 未バインド例外.

send

public final void send(int id,
                       int port,
                       byte[] binary)
                throws InputException,
                       UndefineBindException
データ送信.

対象のデータを送信します.

パラメータ:
id - 送信対象のグループIDを指定します.
port - 送信対象のグループポート番号を指定します.
binary - 送信対象のデータを設定します.
例外:
InputException - 入力例外.
UndefineBindException - 未バインド例外.

send

public final void send(int id,
                       int port,
                       byte[] binary,
                       byte ttl)
                throws InputException,
                       UndefineBindException
データ送信.

対象のデータを送信します.

パラメータ:
id - 送信対象のグループIDを指定します.
port - 送信対象のグループポート番号を指定します.
binary - 送信対象のデータを設定します.
ttl - マルチキャストパケット有効期間を設定します.
例外:
InputException - 入力例外.
UndefineBindException - 未バインド例外.

receive

public final byte[] receive(ConnectAddress addr)
                     throws InputException,
                            UndefineBindException,
                            ConnectTimeoutException
データ受信.

データを受信します.
データが存在しない場合[null]が返されます.

定義:
インタフェース BaseMultiCast 内の receive
パラメータ:
addr - 受信先のIPアドレスとポート番号が格納された 内容が返されます.
戻り値:
byte[] 受信されたバイナリ情報が返されます.
受信対象の情報が存在しない場合[null]が返されます.
例外:
InputException - 入力例外
UndefineBindException - バインド未定義例外.
ConnectTimeoutException - タイムアウト例外.

receive

public final byte[] receive(ConnectAddress addr,
                            int timeout)
                     throws InputException,
                            UndefineBindException,
                            ConnectTimeoutException
データ受信.

データを受信します.
データが存在しない場合[null]が返されます.

定義:
インタフェース BaseMultiCast 内の receive
パラメータ:
addr - 受信先のIPアドレスとポート番号が格納された 内容が返されます.
timeout - 受信タイムアウト値を設定します.
戻り値:
byte[] 受信されたバイナリ情報が返されます.
受信対象の情報が存在しない場合[null]が返されます.
例外:
InputException - 入力例外
UndefineBindException - バインド未定義例外.
ConnectTimeoutException - タイムアウト例外.

receive

public final int receive(byte[] out,
                         ConnectAddress addr)
                  throws InputException,
                         UndefineBindException,
                         ConnectTimeoutException
データ受信.

データを受信します.

定義:
インタフェース BaseMultiCast 内の receive
パラメータ:
out - 受信されたバイナリ情報が設定されます.
addr - 受信先のIPアドレスとポート番号が格納された 内容が返されます.
戻り値:
int 受信されたバイナリ情報長が返されます.
例外:
InputException - 入力例外
UndefineBindException - バインド未定義例外.
ConnectTimeoutException - タイムアウト例外.

receive

public final int receive(byte[] out,
                         ConnectAddress addr,
                         int timeout)
                  throws InputException,
                         UndefineBindException,
                         ConnectTimeoutException
データ受信.

データを受信します.

定義:
インタフェース BaseMultiCast 内の receive
パラメータ:
out - 受信されたバイナリ情報が設定されます.
addr - 受信先のIPアドレスとポート番号が格納された 内容が返されます.
timeout - 受信タイムアウト値を設定します.
戻り値:
int 受信されたバイナリ情報長が返されます.
例外:
InputException - 入力例外
UndefineBindException - バインド未定義例外.
ConnectTimeoutException - タイムアウト例外.

setTTL

public final void setTTL(int ttl)
                  throws InputException
有効期限を設定.

有効期限を設定します.

定義:
インタフェース BaseMultiCast 内の setTTL
例外:
InputException - 入力例外.

getInterface

public final java.net.InetAddress getInterface()
利用インターフェイスを取得.

マルチキャストを行う利用インターフェイスを取得します.

定義:
インタフェース BaseMultiCast 内の getInterface
戻り値:
InetAddress 対象のインターフェイス先が返されます.

getLocal

public final void getLocal(ConnectAddress addr)
ローカルアドレスを取得.

対象のローカルアドレスを取得します.

定義:
インタフェース BaseMultiCast 内の getLocal
パラメータ:
addr - 対象のローカルアドレスが返されます.

getLocal

public final ConnectAddress getLocal()
ローカルアドレスを取得.

対象のローカルアドレスを取得します.

定義:
インタフェース BaseMultiCast 内の getLocal
戻り値:
ConnectAddress 対象のローカルアドレスが返されます.

getLocalAddress

public final java.net.InetAddress getLocalAddress()
ローカルアドレス情報を取得.

ローカルアドレス情報を取得します.

定義:
インタフェース BaseMultiCast 内の getLocalAddress
戻り値:
InetAddress ローカルアドレス情報が返されます.

getLocalPort

public int getLocalPort()
ローカルポート番号を取得.

ローカルポート番号を取得します.

定義:
インタフェース BaseMultiCast 内の getLocalPort
戻り値:
int ローカルポート番号が返されます.

getBuffer

public final int getBuffer()
設定バッファ長を取得.

設定されているバッファ長を取得します.

定義:
インタフェース BaseMultiCast 内の getBuffer
戻り値:
int 設定バッファ長が返されます.

getGroupID

public final int getGroupID()
グループIDを取得.

参加しているグループIDが返されます.

戻り値:
int 現在参加しているグループIDが返されます.
現在グループに参加して無い場合[-1]が返されます.

getTTL

public final int getTTL()
設定されている有効期限を取得.

設定されている有効期限が返されます.

定義:
インタフェース BaseMultiCast 内の getTTL
戻り値:
int 現在参加しているグループに対する有効期限が返されます.

isGroup

public final boolean isGroup()
グループ参加チェック.

現在グループに参加しているかチェックします.

定義:
インタフェース BaseMultiCast 内の isGroup
戻り値:
boolean グループ参加状態が返されます.
[true]が返された場合グループに参加しています.
[false]が返された場合グループに参加していません.

isOpen

public final boolean isOpen()
オープンチェック.

オープンされているかチェックします.

定義:
インタフェース BaseMultiCast 内の isOpen
戻り値:
boolean オープン状態が返されます.
[true]が返された場合、ソケットはオープンされています.
[false]が返された場合、ソケットはオープンされていません.