メッセージキューイングアクセス機能 TP1/Message Queue - Access 使用の手引

[目次][用語][索引][前へ][次へ]

ImqQueueManagerクラス(C++)

このクラスは,キューマネジャをカプセル化(オブジェクトMQOT_Q_MGR)します。

インクルードファイル

このクラスを使用するときは,imqmgr.hppファイルをインクルードしてください。

オブジェクト属性

● authority event

許可事象を制御します。属性は読み取り専用です。

● begin options

beginメソッドに適用されるオプションです。初期値はMQBO_NONEです。

MQBO構造体の,Optionsフィールドに相当します。

● character set

コード化文字セット識別子です。属性は読み取り専用です。

● command input queue name

システムコマンド入力キュー名です。属性は読み取り専用です。

● command level

キューマネジャによってサポートされているコマンドレベルです。属性は読み取り専用です。

● connect options

connectメソッドに適用されるオプションです。初期値はMQCNO_NONEです。

● connection status

TRUEかFALSEかをメソッドに返します。キューマネジャに接続されている場合は,TRUEです。属性は読み取り専用です。

● dead-letter queue name

送達不能キューの名前です。属性は読み取り専用です。

● default transmission queue name

デフォルトの転送キュー名です。属性は読み取り専用です。

● distribution lists

配布リストをサポートするためのキューマネジャの機能です。属性は読み取り専用です。

● first managed object

ImqObjectクラスのconnection referenceメソッドにアドレス指定される複数のオブジェクトのうち,先頭になるオブジェクトです。初期値は0です。

● inhibit event

禁止事象を制御します。属性は読み取り専用です。

● local event

ローカル事象を制御します。属性は読み取り専用です。

● maximum handles

ハンドルの最大数です。属性は読み取り専用です。

● maximum message length

キューマネジャによって管理される任意のキュー上にある任意のメッセージの最大長です。属性は読み取り専用です。

● maximum priority

最高のメッセージ優先順位です。属性は読み取り専用です。

● maximum uncommitted messages

一つのトランザクション内のコミットされていないメッセージの最大数です。属性は読み取り専用です。

● performance event

パフォーマンス事象を制御します。属性は読み取り専用です。

● platform

キューマネジャが収容されているプラットフォームです。属性は読み取り専用です。

● remote event

リモート事象を制御します。属性は読み取り専用です。

● repository name

リポジトリの名前です。属性は読み取り専用です。

● start-stop event

調歩式事象を制御します。属性は読み取り専用です。

● sync-point availability

同期点参加の可用性です。属性は読み取り専用です。

● trigger interval

トリガ間隔です。属性は読み取り専用です。

コンストラクタ

● ImqQueueManager( );

デフォルトのコンストラクタです。

● ImqQueueManager( const ImqQueueManager & manager );

コピーコンストラクタです。connection statusはFALSEです。

● ImqQueueManager( const char * name );

ImqObject nameをnameに設定します。

デストラクタ

ImqQueueManagerオブジェクトは,破棄されると自動的に切断されます。

メソッド

● void operator = ( const ImqQueueManager & mgr );

必要に応じて切断し,次に,mgrからインスタンスデータをコピーします。connection statusはFALSEです。

● ImqBoolean backout( );

コミットされていない変更内容をロールバックします。正常に実行された場合はTRUEを返します。

MQBACK命令に相当します。

● ImqBoolean begin( );

一つのトランザクションを始めます。begin optionsは,このメソッドの動作に影響します。正常に実行された場合はTRUEを返します。

MQBEGIN命令に相当します。

● MQLONG beginOptions( ) const ;

begin optionsを返します。

● void setBeginOptions( const MQLONG options = MQBO_NONE );

begin optionsを設定します。

● ImqBoolean characterSet( MQLONG & ccsid );

character setのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_CODED_CHAR_SET_IDセレクタに相当します。

● MQLONG characterSet( );

考えられるエラーを指示しないで,character setのコピーを返します。

MQINQ命令の,MQIA_CODED_CHAR_SET_IDセレクタに相当します。

● ImqBoolean commit( );

コミットされていない変更内容をコミットします。正常に実行された場合はTRUEを返します。

MQCMIT命令に相当します。

● ImqBoolean connect( );

与えられたImqObject nameを持つキューマネジャへ接続します。デフォルトはローカルキューマネジャです。特定のキューマネジャに接続したい場合は,接続前にImqObject setNameメソッドを使用してください。connect optionsは,このメソッドの動作に影響します。connection statusをTRUEに設定します。正常に実行された場合はTRUEを返します。

MQCONN命令に相当します。

注意
同一のキューマネジャに複数のImqQueueManagerオブジェクトを接続できますが,各接続は,別個のスレッドから実行する必要があります。

● ImqBoolean connectionStatus( ) const ;

connection statusを返します。

● ImqBoolean deadLetterQueueName( ImqString & name );

dead-letter queue nameのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQCA_DEAD_LETTER_Q_NAMEセレクタに相当します。

● ImqString deadLetterQueueName( );

考えられるエラーを指示しないで,dead-letter queue nameのコピーを返します。

MQINQ命令の,MQCA_DEAD_LETTER_Q_NAMEセレクタに相当します。

● ImqBoolean defaultTransmissionQueueName( ImqString & name );

default transmission queue nameのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQCA_DEF_XMIT_Q_NAMEセレクタに相当します。

● ImqString defaultTransmissionQueueName( );

考えられるエラーを指示しないで,default transmission queue nameを返します。

MQINQ命令の,MQCA_DEF_XMIT_Q_NAMEセレクタに相当します。

● ImqBoolean disconnect( );

キューマネジャから切断し,connection statusをFALSEに設定します。このオブジェクトと関連づけられているImqProcessオブジェクト,およびImqQueueオブジェクトはすべて,プログラムの切断前にクローズされ,それぞれのconnection referenceは切断されます。同一のキューマネジャに複数のImqQueueManagerオブジェクトが接続されている場合,最後に切断されるオブジェクトが物理的な切断を実行します。それ以外のオブジェクトは論理的な切断を実行します。物理的な切断時には,コミットされていない変更内容はコミットされます。正常に実行された場合はTRUEを返します。

MQDISC命令に相当します。

● ImqBoolean distributionLists( MQLONG & support );

distribution lists値のコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_DIST_LISTSセレクタに相当します。

● MQLONG distributionLists();

考えられるエラーを指示しないで,distribution lists値を返します。

MQINQ命令の,MQIA_DIST_LISTSセレクタに相当します。

● ImqObject * firstManagedObject( ) const ;

first managed objectを返します。

● ImqBoolean maximumHandles( MQLONG & number );

maximum handlesのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_MAX_HANDLESセレクタに相当します。

● MQLONG maximumHandles( );

考えられるエラーを指示しないで,maximum handlesを返します。

MQINQ命令の,MQIA_MAX_HANDLESセレクタに相当します。

● ImqBoolean maximumMessageLength( MQLONG & length );

maximum message lengthのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_MAX_MSG_LENGTHセレクタに相当します。

● MQLONG maximumMessageLength( );

考えられるエラーを指示しないで,maximum message lengthを返します。

MQINQ命令の,MQIA_MAX_MSG_LENGTHセレクタに相当します。

● ImqBoolean maximumPriority( MQLONG & priority );

maximum priorityのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_MAX_PRIORITYセレクタに相当します。

● MQLONG maximumPriority( );

考えられるエラーを指示しないで,maximum priorityのコピーを返します。

MQINQ命令の,MQIA_MAX_PRIORITYセレクタに相当します。

● ImqBoolean maximumUncommittedMessages( MQLONG & number );

maximum uncommitted messagesのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_MAX_UNCOMMITTED_MSGSセレクタに相当します。

● MQLONG maximumUncommittedMessages( );

考えられるエラーを指示しないで,maximum uncommitted messagesを返します。

MQINQ命令の,MQIA_MAX_UNCOMMITTED_MSGSセレクタに相当します。

● ImqBoolean platform( MQLONG & platform );

platformのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_PLATFORMセレクタに相当します。

● MQLONG platform( );

考えられるエラーを指示しないで,platformを返します。

MQINQ命令の,MQIA_PLATFORMセレクタに相当します。

● ImqBoolean repositoryName( ImqString & name );

repository nameのコピーを提供します。正常に終了した場合はTRUEを返します。

MQINQ命令の,MQCA_REPOSITORY_NAMEセレクタに相当します。

● ImqString repositoryName();

考えられるエラーを指示しないで,repository nameを返します。

MQINQ命令の,MQCA_REPOSITORY_NAMEセレクタに相当します。

● ImqBoolean syncPointAvailability( MQLONG & sync );

sync-point availability値のコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_SYNCPOINTセレクタに相当します。

● MQLONG syncPointAvailability();

考えられるエラーを指示しないで,sync-point availability値のコピーを返します。

MQINQ命令の,MQIA_SYNCPOINTセレクタに相当します。

● ImqBoolean triggerInterval( MQLONG & interval );

trigger intervalのコピーを提供します。正常に実行された場合はTRUEを返します。

MQINQ命令の,MQIA_TRIGGER_INTERVALセレクタに相当します。

● MQLONG triggerInterval( );

考えられるエラーを指示しないで,trigger intervalを返します。

MQINQ命令の,MQIA_TRIGGER_INTERVALセレクタに相当します。

メソッド(protected)

● void setFirstManagedObject( const ImqObject * object = 0 );

first managed objectを設定します。

オブジェクト属性(protected)

● MQHCONN ohconn

TP1/Message Queue - Access接続ハンドルです。connection statusがTRUEである場合だけ意味を持ちます。

その他の関連クラス

ImqObject

理由コード

理由コードの詳細については,「付録A 理由コード」,またはマニュアル「TP1/Message Queue プログラム作成リファレンス」を参照してください。