概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## com.JRcServer.commons.net
クラス UdpProtocol

    java.lang.Object
      com.JRcServer.commons.net.UdpProtocol

すべての実装されたインタフェース:
  BaseUdpProtocol

    public class UdpProtocol

extends java.lang.Object
implements BaseUdpProtocol

UDPプロトコルオブジェクト.
UDPプロトコルで処理するオブジェクトです.

導入されたバージョン:
  JRcCommons 1.00
バージョン:
  1.00, 2004/10/19
作成者:
  Masahito Suzuki

フィールドの概要

インタフェース com.JRcServer.commons.net.BaseUdpProtocol から継承されたフィールド
`ALL_MODE, BUF_LENGTH, NOT_MODE, RCV_MODE, SND_MODE`

コンストラクタの概要
`UdpProtocol()` コンストラクタ.

メソッドの概要
`void` | `close()` クローズ処理.
`int` | `getBuffer()` 設定バッファ長を取得.
`ConnectAddress` | `getLocal()` ローカルアドレスを取得.
`void` | `getLocal(ConnectAddress addr)` ローカルアドレスを取得.
`java.net.InetAddress` | `getLocalAddress()` ローカルアドレス情報を取得.
`int` | `getLocalPort()` ローカルポート番号を取得.
`boolean` | `isOpen()` オープンチェック.
`void` | `open(int bufLen)` オープン処理.
`void` | `open(int bufLen, int port)` オープン処理.
`void` | `open(int bufLen, int port, java.net.InetAddress addr)` オープン処理.
`void` | `openTo(int bufMode, int bufLen)` オープン処理.
`void` | `openTo(int bufMode, int bufLen, int port)` オープン処理.
`void` | `openTo(int bufMode, int bufLen, int port, java.net.InetAddress addr)` オープン処理.
`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, ConnectAddress addr)` データ送信.
`void` | `send(byte[] binary, java.net.InetAddress addr, int port)` データ送信.

クラス java.lang.Object から継承されたメソッド
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### UdpProtocol

    public UdpProtocol()

  コンストラクタ.

メソッドの詳細

### open

    public final void open(int bufLen)
                    throws NotBindException

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

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

### open

    public final void open(int bufLen,
                           int port)
                    throws InputException,
                           NotBindException

  オープン処理.
  対象のポート番号をオープンします.

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

### open

    public final void open(int bufLen,
                           int port,
                           java.net.InetAddress addr)
                    throws InputException,
                           NotBindException

  オープン処理.
  対象の自IPアドレス上にポート番号でオープンします.
  この処理の場合、対象のアドレスはDHCPから割り振られたアドレスで無い事が 条件となります.

  定義:
    インタフェース `BaseUdpProtocol` 内の `open`
  パラメータ:
    `bufLen` - 送受信バッファ長を設定します.
    `port` - オープン対象のポート番号を設定します.
    `addr` - オープン対象の自IPアドレスを設定します.
  例外:
    `InputException` - 入力例外.
    `NotBindException` - バインド失敗.

### openTo

    public final void openTo(int bufMode,
                             int bufLen)
                      throws NotBindException

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

  定義:
    インタフェース `BaseUdpProtocol` 内の `openTo`
  パラメータ:
    `bufMode` - バッファモードを設定します.
    [UdpProtocol#NOT_MODE]を指定した場合、デフォルト値の バッファ長を設定します.
    [UdpProtocol#SND_MODE]を指定した場合、送信側バッファのみ バッファ値を設定します.
    [UdpProtocol#RCV_MODE]を指定した場合、受信側バッファのみ バッファ値を設定します.
    [UdpProtocol#ALL_MODE]を指定した場合、送信/受信側バッファに バッファ値を設定します.
    `bufLen` - 送受信バッファ長を設定します.
  例外:
    `NotBindException` - バインド失敗.

### openTo

    public final void openTo(int bufMode,
                             int bufLen,
                             int port)
                      throws InputException,
                             NotBindException

  オープン処理.
  対象のポート番号をオープンします.

  定義:
    インタフェース `BaseUdpProtocol` 内の `openTo`
  パラメータ:
    `bufMode` - バッファモードを設定します.
    [UdpProtocol#NOT_MODE]を指定した場合、デフォルト値の バッファ長を設定します.
    [UdpProtocol#SND_MODE]を指定した場合、送信側バッファのみ バッファ値を設定します.
    [UdpProtocol#RCV_MODE]を指定した場合、受信側バッファのみ バッファ値を設定します.
    [UdpProtocol#ALL_MODE]を指定した場合、送信/受信側バッファに バッファ値を設定します.
    `bufLen` - 送受信バッファ長を設定します.
    `port` - オープン対象のポート番号を設定します.
  例外:
    `InputException` - 入力例外.
    `NotBindException` - バインド失敗.

### openTo

    public final void openTo(int bufMode,
                             int bufLen,
                             int port,
                             java.net.InetAddress addr)
                      throws InputException,
                             NotBindException

  オープン処理.
  対象の自IPアドレス上にポート番号でオープンします.
  この処理の場合、対象のアドレスはDHCPから割り振られたアドレスで無い事が 条件となります.

  定義:
    インタフェース `BaseUdpProtocol` 内の `openTo`
  パラメータ:
    `bufMode` - バッファモードを設定します.
    [UdpProtocol#NOT_MODE]を指定した場合、デフォルト値の バッファ長を設定します.
    [UdpProtocol#SND_MODE]を指定した場合、送信側バッファのみ バッファ値を設定します.
    [UdpProtocol#RCV_MODE]を指定した場合、受信側バッファのみ バッファ値を設定します.
    [UdpProtocol#ALL_MODE]を指定した場合、送信/受信側バッファに バッファ値を設定します.
    `bufLen` - 送受信バッファ長を設定します.
    `port` - オープン対象のポート番号を設定します.
    `addr` - オープン対象の自IPアドレスを設定します.
  例外:
    `InputException` - 入力例外.
    `NotBindException` - バインド失敗.

### close

    public final void close()

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

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

### send

    public final void send(byte[] binary,
                           ConnectAddress addr)
                    throws InputException,
                           UndefineBindException

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

  定義:
    インタフェース `BaseUdpProtocol` 内の `send`
  パラメータ:
    `binary` - 送信対象のデータを設定します.
    `addr` - 送信対象のIPアドレス/ポート番号を指定します.
  例外:
    `InputException` - 入力例外.
    `UndefineBindException` - 未バインド例外.

### send

    public final void send(byte[] binary,
                           java.net.InetAddress addr,
                           int port)
                    throws InputException,
                           UndefineBindException

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

  定義:
    インタフェース `BaseUdpProtocol` 内の `send`
  パラメータ:
    `binary` - 送信対象のデータを設定します.
    `addr` - 送信対象のIPアドレスを指定します.
    `port` - 送信対象のポート番号を設定します.
  例外:
    `InputException` - 入力例外.
    `UndefineBindException` - 未バインド例外.

### receive

    public final byte[] receive(ConnectAddress addr)
                         throws UndefineBindException,
                                ConnectTimeoutException

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

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

### receive

    public final byte[] receive(ConnectAddress addr,
                                int timeout)
                         throws UndefineBindException,
                                ConnectTimeoutException

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

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

### receive

    public final int receive(byte[] out,
                             ConnectAddress addr)
                      throws InputException,
                             UndefineBindException,
                             ConnectTimeoutException

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

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

### receive

    public final int receive(byte[] out,
                             ConnectAddress addr,
                             int timeout)
                      throws InputException,
                             UndefineBindException,
                             ConnectTimeoutException

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

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

### getLocal

    public final void getLocal(ConnectAddress addr)

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

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

### getLocal

    public final ConnectAddress getLocal()

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

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

### getLocalAddress

    public final java.net.InetAddress getLocalAddress()

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

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

### getLocalPort

    public final int getLocalPort()

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

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

### getBuffer

    public final int getBuffer()

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

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

### isOpen

    public final boolean isOpen()

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

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

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド