|
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||
public interface ObexSocket
OBEXライブラリにて送受信を担当するクラスが実装すべき基本事項を定義するインターフェースです。 標準で提供している、赤外線（Windowsのみ）、TCP/IP以外の通信手段をOBEXライブラリで使用する場合にアプリケーションが実装します。
通常はこのインターフェースを直接実装せずに、サーバー側の送受信はObexServerSocketインターフェースを、クライアント側の送受信はObexClientSocketインターフェースを実装することで行います。
ObexManager| メソッドの概要 | |
|---|---|
void |
close()
ソケットをクローズします。 |
int |
getMTU()
このソケットが一度に送受信可能なパケットサイズの上限を返します。 |
void |
open()
ソケットをオープンします。 |
int |
receive(byte[] byPacket,
int nIndex,
int nLength)
通信経路からデータを受信ます。 |
int |
send(byte[] byPacket,
int nIndex,
int nLength)
通信経路へデータを送信します。 |
void |
setParameter(java.lang.Object obj)
このソケットが解釈する実装依存のパラメータオブジェクトを設定します。 |
| メソッドの詳細 |
|---|
void setParameter(java.lang.Object obj)
このソケットが解釈する実装依存のパラメータオブジェクトを設定します。 OBEXライブラリはインスタンスを生成後、このメソッドを呼び出します。
パラメータが不適切な場合はIllegalArgumentException例外クラスをthrowします。
obj - アプリケーションからパラメータとして受け取ったオブジェクトを渡します。int getMTU()
このソケットが一度に送受信可能なパケットサイズの上限を返します。 OBEXライブラリはこのサイズを元にパケットの生成およびネゴシエーションを行います。
サイズは最低でも64バイト程度、最大で65535バイト以下でなければなりません。
void open()
throws ObexException
ソケットをオープンします。 OBEXライブラリが通信を開始する前に１度呼び出します。
ソケットが通信に際して初期化を必要とする場合はこのメソッドで処理を実装します。
ObexException
void close()
throws ObexException
ソケットをクローズします。 OBEXライブラリが通信を終了する際に１度呼び出します。
通信経路を閉じたり確保しているリソースを開放したりする処理を実装します。
ObexException
int receive(byte[] byPacket,
int nIndex,
int nLength)
throws ObexException
通信経路からデータを受信ます。 OBEXライブラリはパケットの境界とは関係なく、必要な量のデータを受信します。 必要に応じて（必要であれば）ソケット側でパケットの境界を抽象化する必要があります。
データはnLengthバイトを受信し、byPacket内のnIndexからに格納します。
受信可能なバイト数がnLength以下の場合はそのバイト数までのデータでもかまいません。
そして受信したバイト数を戻り値とします。
データを受信することが出来ない場合は最も近い理由のステータスコードを設定したObexException例外クラスをthrowします。
byPacket - 受信したデータを受け取るbyte配列のバッファを渡します。nIndex - 受信したデータの格納を開始する位置を渡します。nLength - 受信するデータのバイト数を渡します。
ObexException - データの受信に失敗した場合に必要な設定をしてthrowします。
int send(byte[] byPacket,
int nIndex,
int nLength)
throws ObexException
通信経路へデータを送信します。 OBEXライブラリはパケットの境界とは関係なく、必要な量のデータを送信します。 必要に応じて（必要であれば）ソケット側でパケットの境界を抽象化する必要があります。
送信するデータはbyPacket内のnIndexが示す位置からnLengthバイトのデータです。
送信可能なバイト数がnLength以下の場合はそのバイト数までのデータの送信でもかまいません。
そしてその送信したバイト数を戻り値とします。
データを送信することが出来ない場合は最も近い理由のステータスコードを設定したObexException例外クラスをthrowします。
byPacket - 送信するデータを保持するbyte配列のバッファを渡します。nIndex - 送信するデータの開始位置を渡します。nLength - 送信するデータのバイト数を渡します。
ObexException - データの送信に失敗した場合に必要な設定をしてthrowします。
|
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||