Connection オブジェクトは、アプリケーションによるブローカーへのアクティブな接続を表します。
xms::PropertyContext | +----xms::Connection
Connection オブジェクトの XMS 定義プロパティーのリストについては、Connection のプロパティーを参照してください。
メソッド | 説明 |
---|---|
close | 接続を閉じます。 |
createSession | セッションを作成します。 |
getClientID | 接続のクライアント ID を取得します。 |
getExceptionListener | 接続に登録されている例外リスナーへのポインターを取得します。 |
getHandle | C アプリケーションが接続にアクセスするときに使用するハンドルを取得します。 |
getMetaData | 接続のメタデータを取得します。 |
isNull | Connection オブジェクトがヌル・オブジェクトであるかどうかを判別します。 |
setClientID | 接続のクライアント ID を設定します。 |
setExceptionListener | 接続に、例外リスナーを登録します。 |
start | 接続の着信メッセージの配信を開始または再開します。 |
stop | 接続の着信メッセージの配信を停止します。 |
Session createSession(const xmsBOOL transacted, const xmsINT acknowledgeMode);
ブローカーへのリアルタイム接続の場合、値は xmsFALSE である必要があります。
セッションが処理済みの場合、このパラメーターは無視されます。肯定応答モードについて詳しくは、セッションでのメッセージの受信の確認を参照してください。
ExceptionListener * getExceptionListener() const;
接続に登録されている例外リスナーへのポインターを取得します。
例外リスナーの使用について詳しくは、C++ での例外リスナーの使用法を参照してください。
xmsVOID setClientID(const String & clientID);
接続のクライアント ID を設定します。クライアント ID は、パブリッシュ/サブスクライブ・ドメイン内の永続サブスクリプションをサポートするためだけに使用され、Point-to-Point ドメインでは無視されます。
アプリケーションがこのメソッドを呼び出して接続のクライアント ID を設定する場合、アプリケーションは、接続の作成の直後に、接続で他の操作を実行する前にこの設定を行う必要があります。アプリケーションが、この時点よりも後に、このメソッドの呼び出しを試行すると、呼び出しは例外 XMS_X_ILLEGAL_STATE_EXCEPTION をスローします。
ブローカーへのリアルタイム接続の場合、このメソッドは無効です。
xmsVOID setExceptionListener(const ExceptionListener *lsr);
例外リスナーの使用について詳しくは、C++ での例外リスナーの使用法を参照してください。
接続に例外リスナーが既に登録されている場合、代わりに NULL ポインターを指定することによって、登録を取り消すことができます。