Everything

trcv_mbf

概要
メッセージの受信(タイムアウト付き)
C言語形式
 ER_UINT  trcv_mbf ( ID mbfid, VP msg, TMO tmout );
パラメータ
I/O
パラメータ
説明
I
 ID      mbfid;
メッセージ・バッファのID
O
 VP      msg;
メッセージを格納する領域へのポインタ
I
 TMO     tmout;
待ち時間(単位:ミリ秒)
TMO_FEVR: 永久待ち
TMO_POL: ポーリング
数値: 待ち時間

機能
mbfidで指定されたメッセージ・バッファの状況に応じて,以下の処理を行います。
- メッセージ・バッファにメッセージが格納されている場合
メッセージ・バッファから最古のメッセージを取り出してmsgで指定された領域に格納し,そのメッセージサイズを戻り値として返します。このとき,対象メッセージ・バッファの空き領域は以下の式で算出されるサイズだけ増加します。
 増加サイズ=up4( 戻り値 )+VTSZ_MBFTBL
さらに以下を,送信待ちキューにタスクがなくなるか,メッセージを格納できなくなるまで繰り返します。
- 送信待ちキューにタスクがキューイングされており,キュー先頭のタスクが指定したメッセージのサイズだけの空き領域がある場合は,そのメッセージをメッセージ・バッファに格納します。これにより,該当タスクは,送信待ちキューから外れ,WAITING状態(メッセージ送信待ち状態)からREADY状態へ,またはWAITING-SUSPENDED状態からSUSPENDED状態へと遷移します。また,このとき対象メッセージ・バッファの空き領域は以下の式で算出されるサイズだけ減少します。
 減少サイズ=up4(該当タスクが送信したメッセージ・サイズ)+VTSZ_MBFTBL
- メッセージ・バッファにメッセージが格納されておらず,送信待ちキューにタスクがキューイングされている場合
送信待ちキュー先頭のタスクが指定したメッセージをmsgで指定された領域に格納し,そのメッセージサイズを戻り値として返します。これにより,該当タスクは,送信待ちキューから外れ,WAITING状態(メッセージ送信待ち状態)からREADY状態へ,またはWAITING-SUSPENDED状態からSUSPENDED状態へと遷移します。
なお,この状況は,メッセージ・バッファのサイズが0の場合のみ生じます。
- メッセージ・バッファにメッセージが格納されておらず,送信待ちキューにタスクがキューイングされていない場合
自タスクを対象メッセージ・バッファの受信待ちキューにキューイングしたのち,RUNNING状態からタイムアウト付きのWAITING状態(メッセージ受信待ち状態)へと遷移させます。
なお,メッセージ受信待ち状態の解除は,以下の場合に行われます。
 
メッセージ受信待ち状態の解除操作
戻り値
snd_mbfの発行により,対象メッセージ・バッファにメッセージが送信された。
E_OK
psnd_mbfの発行により,対象メッセージ・バッファにメッセージが送信された。
E_OK
ipsnd_mbfの発行により,対象メッセージ・バッファにメッセージが送信された。
E_OK
tsnd_mbfの発行により,対象メッセージ・バッファにメッセージが送信された。
E_OK
rel_waiの発行により,待ち状態を強制的に解除された。
E_RLWAI
irel_waiの発行により,待ち状態を強制的に解除された。
E_RLWAI
パラメータtmoutで指定された待ち時間が経過した
E_TMOUT
del_mbfの発行により,待ち状態を強制的に解除された。
E_DLT

備考1 最大メッセージ・サイズは,メッセージ・バッファの生成時に指定します。msgの指す領域は,必ず最大メッセージ・サイズ以上としてください。
備考2 自タスクを対象メッセージ・バッファの受信待ちキューにキューイングする際のキューイング方式は,FIFO順に行われます。
備考3 待ち時間tmoutTMO_FEVRが指定された際には“rcv_mbfと同等の処理”を,TMO_POLが指定された際には“prcv_mbfと同等の処理”を実行します。
戻り値
マクロ
数値
意味


正常終了(受信したメッセージのサイズ)
E_PAR
-17
パラメータ・エラー
- msg == NULL
- tmout < -1
- tmout > (0x7FFFFFFF - TIC_NUME)/TIC_DENO
E_ID
-18
不正ID番号
- mbfid≦0
- mbfid > VTMAX_MBF
E_CTX
-25
コンテキスト・エラー
- 非タスクから本サービス・コールを発行した。
- CPUロック状態から本サービス・コールを発行した。
- ディスパッチ禁止状態から本サービス・コールを発行した。
- 「PSW.IPL > カーネル割り込みマスクレベル」の状態から本サービス・コールを発行した。
E_MACV
-26
メモリ・アクセス違反
- スタック・ポインタが呼出しタスクのユーザ・スタック領域の範囲外を指している。
- 呼び出しタスクからのmsgが示す領域(先頭:msg,サイズ:生成時に指定した最大メッセージ・サイズ)に対するオペランド・ライト・アクセス許可がない。
E_NOEXS
-42
オブジェクト未生成
- mbfidのメッセージ・バッファが存在しない。
E_RLWAI
-49
待ち状態の強制解除
- rel_waiまたはirel_waiの発行により,待ち状態を強制的に解除された。
E_TMOUT
-50
待ち時間が経過した,またはポーリング失敗
E_DLT
-51
待ちオブジェクトの削除
- del_mbfの発行により,待ち状態を強制的に解除された。