com.JRcServer.commons.net
インタフェース BaseMultiCast

既知の実装クラスの一覧:
MultiCastV4

public interface BaseMultiCast

マルチキャストインターフェイス.

マルチキャストUDPプロトコルインターフェイスです.

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

フィールドの概要
static int BUFFER
          受信バッファ長.
static int DEF_BUFFER
          受信デフォルトバッファ長.
static int DEF_PORT
          デフォルトポート番号.
static byte DEF_TTL
          デフォルトTTL(TimeToLive).
 
メソッドの概要
 void close()
          クローズ処理.
 int getBuffer()
          設定バッファ長を取得.
 java.net.InetAddress getInterface()
          利用インターフェイスを取得.
 ConnectAddress getLocal()
          ローカルアドレスを取得.
 void getLocal(ConnectAddress addr)
          ローカルアドレスを取得.
 java.net.InetAddress getLocalAddress()
          ローカルアドレス情報を取得.
 int getLocalPort()
          ローカルポート番号を取得.
 int getTTL()
          設定されている有効期限を取得.
 boolean isGroup()
          グループ参加チェック.
 boolean isOpen()
          オープンチェック.
 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 setInterface(java.net.InetAddress inf)
          利用インターフェイスを設定.
 void setTTL(int ttl)
          有効期限を設定.
 

フィールドの詳細

BUFFER

static final int BUFFER
受信バッファ長.

受信時のバッファ長です.

関連項目:
定数フィールド値

DEF_BUFFER

static final int DEF_BUFFER
受信デフォルトバッファ長.

受信時のデフォルトバッファ長です.

関連項目:
定数フィールド値

DEF_PORT

static final int DEF_PORT
デフォルトポート番号.

デフォルトのポート番号です.

関連項目:
定数フィールド値

DEF_TTL

static final byte DEF_TTL
デフォルトTTL(TimeToLive).

デフォルトのTTL値を設定します.

関連項目:
定数フィールド値
メソッドの詳細

open

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

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

例外:
NotBindException - バインド失敗.

open

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

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

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

open

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

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

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

open

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

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

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

close

void close()
クローズ処理.

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


setInterface

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

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

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

leaveGroup

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

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


send

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

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

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

send

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

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

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

receive

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

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

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

receive

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

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

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

receive

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

データを受信します.

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

receive

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

データを受信します.

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

setTTL

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

有効期限を設定します.

例外:
InputException - 入力例外.

getInterface

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

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

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

getLocal

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

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

パラメータ:
addr - 対象のローカルアドレスが返されます.

getLocal

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

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

戻り値:
ConnectAddress 対象のローカルアドレスが返されます.

getLocalAddress

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

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

戻り値:
InetAddress ローカルアドレス情報が返されます.

getLocalPort

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

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

戻り値:
int ローカルポート番号が返されます.

getBuffer

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

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

戻り値:
int 設定バッファ長が返されます.

getTTL

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

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

戻り値:
int 現在参加しているグループに対する有効期限が返されます.

isGroup

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

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

戻り値:
boolean グループ参加状態が返されます.
[true]が返された場合グループに参加しています.
[false]が返された場合グループに参加していません.

isOpen

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

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

戻り値:
boolean オープン状態が返されます.
[true]が返された場合、ソケットはオープンされています.
[false]が返された場合、ソケットはオープンされていません.