javax.microedition.io
インタフェース CommConnection

すべてのスーパーインタフェース:

Connection, InputConnection, OutputConnection, StreamConnection

public interface CommConnection
extends Connection, InputConnection, OutputConnection, StreamConnection

このインタフェースは論理的なシリアル・ポート接続を定義します。 "論理的"なシリアル・ポートはバイト・データが順次転送される論理的な接続と定義されます。 論理的なシリアル・ポートはオペレーティング・システムが定義するもので、必ずしも物理的な RS-232C シリアル・ポートであるとは限りません。 例えば"論理的"なシリアル・ポートとしてオペレーティング・システムが提供するものには、IrDA による IrCOMM ポートなどがあります。

COMM ポートには明示的な識別子とセミコロン（;）で分割された埋め込み構成パラメータから構成される Generic Connection フレームワーク文字列を用いてアクセスします。

同時に１つのアプリケーションだけを特定のシリアル・ポートに接続することができます。 既にオープンされているシリアル・ポートをアプリケーションが Connector.open 系メソッドで開こうとすると IOException を throw します。

接続を開くために使用する URI はタイプとパラメータから構成されます。 RFC2396 で定義されたスキームは以下の通りです。

comm:<ポート識別子>[<オプション・パラメータ>]

最初のパラメータはポート識別子でなければなりません。この識別子は論理的な装置名です。 通常、これらの識別子はデバイス特有であり慎重に使用しなければなりません。

特定のデバイスとＯＳにおいて有効な識別子は、システム・プロパティ"microedition.commports"を System クラスの getProperty() メソッドで呼び出すことで取得することができます。 これにより"comm:"に結合して使用可能なポート識別子を、カンマ（,）区切りで連結した状態のリストを返します。 シリアル・ポート接続を開く際に使用する URI 文字列にする際はポート識別子の前に"comm:"を前に置きます。

接続を開くための文字列には以下のポート命名規則が適用されます。

• 全ての追加パラメータはセミコロン（;）で切り離さなければならず、スペース（ ）を含む文字列は許されません。
• 任意のパラメータが特定の指定されたポートにとって適切でなければ、パラメータを無視することがあります。
• ポート識別子がセミコロン (;）を含んではなりません。

正しいパラメータは以下のパラメータ定義によって定義されます。

• 不正あるいは認識することができないパラメータの場合には IllegalArgumentException を throw します。
• パラメータの値がデバイスによってサポートされるならば、その指定が尊重されます。
• パラメータの値をサポートすることができないのであれば IOException を throw します。
• "baudrate"パラメータが指定された場合、setBaudRate(int) メソッドでの指定と同等に扱います。 例えば要求されたボーレートをサポートしていないのであれば、システムは有効なボーレートを代入するかもしれません。 これは設定後に getBaudRate() メソッドを呼び出して設定値と比較することで発見することができます。

オプション・パラメータ

Generic Connection フレームワーク接続文字列のための BNF フォーマット

URI は以下で指定する BNF 構文規則に従わなければなりません。 URI がこの構文規則に合致しない場合は IllegalArgumentException を throw します。

セキュリティ

シリアル・ポートへのアクセスは、権限の無いデータの送信や受信を防ぐために制限されます。 シリアル・ポート接続に適用されるセキュリティ・モデルは実装するプロファイルにて定義されます。 セキュリティ・モデルは Connector クラスの open() メソッドで使用可能なシリアル・ポート接続文字列に適用されるでしょう。 プロファイルによる認証の結果、アプリケーションによるシリアル・ポートへのアクセスを許可しない場合には Connector クラスの open() メソッドの呼び出し時に SecurityException を throw します。 また、他のオープン系メソッド（openInputStream()、openOutputStream()、openDataInputStream()、openDataOutputStream()）を呼び出した際にもセキュリティ・モデルが適用されるかもしれません。

例

CommConnection を使用した簡単なループバック・プログラムの記述例を以下に示します。

CommConnection cc = (CommConnection)
            Connector.open("comm:com0;baudrate=19200");
 int baudrate = cc.getBaudRate();
 InputStream is  = cc.openInputStream();
 OutputStream os = cc.openOutputStream();
 int ch = 0;
 while(ch != 'Z') {
     os.write(ch);
     ch = is.read();
     ch++;
 }
 is.close();
 os.close();
 cc.close();

CommConnection をオープンするためのポート識別子を取得するプログラムの記述例を以下に示します。

String port1;
 String ports = System.getProperty("microedition.commports");
 int comma = ports.indexOf(',');
 if (comma > 0) {
     // 使用可能ポート・リストから最初のポートを切り出します。
     port1 = ports.substring(0, comma);
 } else {
     // 使用可能なシリアル・ポートは１つのみです。
     port1 =ports;
 }

推奨するポート命名規約

英数字の自由な組み合わせを使用することで、プラットフォーム命名規則に合わせた論理的なポート名を定義することができます。 しかしながら、このクラスの実装において提案する規約に従ってポート名を命名することを推奨します。

仮想マシン実装は以下の規約に基づくべきです。

• ポート名はポートの数にしたがってテキスト略語に連番を加えたものとします。
• 以下のデバイス名タイプを使用すべきです。
  • COM#（RS-232（さかき注：現 EIA-232）を示す COM に、ポートに割り当てられた連番 # を組み合わせた文字列です）。
  • IR#（IrDA の IrCOMM ポートを示す IR に、ポートに割り当てられた連番 # を組み合わせた文字列です）。
• 一般にこの命名体系で API の使用者は、使用しようとしているポートのタイプを判別しています。 例えば、アプリケーションが１つのデータを「ビーム（赤外線送信）」するつもりなら、接続をオープンするために"IR#" を探すかもしれません。 代替手段として考えられるのは利用可能なポートに関して試行錯誤を行うアプローチです。

導入されたバージョン:

MIDP 2.0

getBaudRate

int getBaudRate()

シリアル・ポート接続のボーレートを返します。

戻り値:

この接続のボーレートを返します（単位： bps）。

関連項目:

setBaudRate(int)

setBaudRate

int setBaudRate(int baudrate)

シリアル・ポート接続にボーレートを設定します。 指定したボーレートをプラットフォームがサポートしていないならば、システムは代替の有効なボーレートを適用するかもしれません。 getBaudRate() メソッドを呼び出して取得した値と設定した値を比較することで、代替ボーレートが適用されたか否かを判定することができます。

パラメータ:

baudrate - この接続に設定するボーレートを渡します（単位： bps）。

戻り値:

今回の設定前のボーレートを返します（単位： bps）。

関連項目:

getBaudRate()