SAMConnection->receiveSAMConnection->remove
(PECL sam >= 0.1.0)
SAMConnection->remove — メッセージをキューから削除する
説明
SAMConnection
SAMMessage remove
( string $target
[, array $properties
] )
メッセージをキューから削除します。
パラメータ
- target
-
メッセージを削除するキューの識別子。
- properties
-
オプションの連想配列で、削除操作を制御するパラメータを指定します。
プロパティ名 とりうる値 SAM_CORRELID メッセージの、対象相関 ID 文字列。 典型的な例は、"send" リクエストが返す相関 ID 文字列となります。 SAM_MESSAGEID 削除されるメッセージのメッセージ ID 文字列。
返り値
このメソッドは、エラーが発生した場合に FALSE を返します。
例
例1 メッセージ ID を指定して、メッセージをキューから削除する
<?php
if (!$conn->remove('queue://receive/test', array(SAM_MESSAGEID => $messageId))) {
// 削除に失敗しました!
echo "Remove failed ($conn->errno) $conn->error";
}
?>
add a note
User Contributed NotesSAMConnection->remove
There are no user contributed notes for this page.