OS_ReadMessage

構文

#include <nitro/os.h>

BOOL OS_ReadMessage(
     OSMessageQueue*   mq,
     OSMessage*        msg,
     s32               flags );

引数

mq	メッセージキューへのポインタ
msg	覗いたメッセージ
flags	`OS_MESSAGE_BLOCK`を設定した場合、`OS_ReadMessage`関数は、空のキューをブロックします。 `OS_MESSAGE_NOBLOCK`を設定した場合、`OS_ReadMessage`関数は、キューが空であろうとなかろうと、すぐに返ります。

返り値

メッセージがうまく取り出せた場合、TRUE を返します。
OS_MESSAGE_NOBLOCK が指定され、キューが空であった場合、FALSE を返します。

説明

メッセージキューの先頭のメッセージをコピーします。
メッセージキューの状態は変化しません。また OS_ReceiveMessatge() と違って、このキューにメッセージを送るために待ち状態のスレッドを実行可能状態にすることもありません。いわば、OS_ReadMessage() は、メッセージキューの先頭のメッセージを覗くための関数です。

flagsにOS_MESSAGE_BLOCKを設定した場合、キューが空 (empty) であれば、この関数を呼び出したスレッドは一時停止されます。メッセージがキューに送られるとすぐに再開されます。より高い優先順位の受信スレッドが他にあった場合、これらのスレッドが最初に実行し、メッセージを取り出す点に注意してください。このスレッドが実行する時にメッセージキューが空であった場合、他のメッセージがキューに送られるまで、このスレッドは再び一時停止します。

flagsにOS_MESSAGE_NOBLOCKを設定した場合、呼び出したスレッドにすぐに戻ります。キューが空でなければ、TRUE を返し、キューが空であればFALSE を返します。

参照

OS_InitMessageQueue, OS_SendMessage, OS_ReceiveMessage

履歴

2004/03/12 初版