Windows版 iTRONサービスコールの作成 (メールボックス)
(その6)

メールボックスの状態を参照する

メールボックスの状態を参照するサービスコールは以下のとおりです。


サービスコール名説明
ref_mbx

メールボックスの状態を取得します。

Ver3.0と4.0では関数名は同じですが、引数の順番が逆になりますので注意してください。

メールボックスの状態を取得する (Ver3.0)

Ver3.0でメールボックスの状態を取得するには以下のサービスコールを使用します。



    ER ref_mbx( T_RMBX *pk_rmbx, ID mbxid )
	

引数説明
pk_rmbx

メールボックス状態を格納する構造体のポインタ。

mbxid

メールボックスID番号。

戻り値説明
E_OK

正常終了。

E_ID

範囲外のメールボックスID番号。

E_NOEXS

指定したメールボックスID番号は登録されていない。

E_PAR

パラメータエラー。


メールボックス状態を格納する構造体(T_RMBX)は以下のとおりです。

メンバ名説明
exinf拡張情報。
wtsk待ちタスクの有無。
pk_msgメッセージキューの先頭のメッセージパケットのポインタ。


・サービスコールのソースコードは以下のようになります。


/****************************************************************************/
/*!
 *  @brief  メールボックスの状態参照.
 *
 *  @param  [out]   pk_rmbx メールボックス状態を格納する構造体のポインタ.
 *  @param  [in]    mbxid   メールボックスID番号.
 *
 *  @retval エラーコード.
 */
ER      ref_mbx( T_RMBX *pk_rmbx, ID mbxid )
{
    ER          ercd;
    WIMBXSTAT   sts;

    //! 引数が不正な場合はエラーにする.
    if( !pk_rmbx ){
        return E_PAR;
    }
    wi_CommonLock();

    //! メールボックスの状態を取得する.
    ercd = wi_RefarenceMailBox( mbxid, &sts );
    if( ercd == E_OK ){
        pk_rmbx->exinf  = sts.ExtInfo;
        pk_rmbx->wtsk   = (BOOL_ID)sts.WaitId;
        pk_rmbx->pk_msg = sts.NextMsg;
    }
    wi_CommonUnlock();
    return ercd;
}
	

メールボックス状態を格納する構造体のポインタがNULLの場合エラーにします。

メールボックス状態を取得する関数を呼び出して現在のメールボックスの状態を取得し引数の構造体に格納します。

メールボックスの状態を取得する (Ver4.0)

Ver4.0でメールボックスの状態を取得するには以下のサービスコールを使用します。



    ER ref_mbx( ID mbxid, T_RMBX *pk_rmbx )
	

引数説明
mbxid

メールボックスID番号。

pk_rmbx

メールボックス状態を格納する構造体のポインタ。

戻り値説明
E_OK

正常終了。

E_ID

範囲外のメールボックスID番号。

E_NOEXS

指定したメールボックスID番号は登録されていない。

E_PAR

パラメータエラー。


メールボックス状態を格納する構造体(T_RMBX)は以下のとおりです。

メンバ名説明
wtskidメールボックス待ち行列の先頭のタスクのID番号。
pk_msgメッセージキューの先頭のメッセージパケットのポインタ。


・サービスコールのソースコードは以下のようになります。


/****************************************************************************/
/*!
 *  @brief  メールボックスの状態参照.
 *
 *  @param  [in]    mbxid   メールボックスID番号.
 *  @param  [out]   pk_rmbx メールボックス状態を格納する構造体のポインタ.
 *
 *  @retval エラーコード.
 */
ER      ref_mbx( ID mbxid, T_RMBX *pk_rmbx )
{
    ER          ercd;
    WIMBXSTAT   sts;

    //! 引数が不正な場合はエラーにする.
    if( !pk_rmbx ){
        return E_PAR;
    }
    wi_CommonLock();

    //! メールボックスの状態を取得する.
    ercd = wi_RefarenceMailBox( mbxid, &sts );
    if( ercd == E_OK ){
        pk_rmbx->wtskid = sts.WaitId;
        pk_rmbx->pk_msg = sts.NextMsg;
    }
    wi_CommonUnlock();
    return ercd;
}
	

メールボックス状態を格納する構造体のポインタがNULLの場合エラーにします。

メールボックス状態を取得する関数を呼び出して現在のメールボックスの状態を取得し引数の構造体に格納します。

メールボックス状態取得関数

メールボックス状態を取得する関数のソースコードは以下のとおりです。



/****************************************************************************/
/*!
 *  @brief  メールボックスの状態参照.
 *
 *  @param  [in]    id      メールボックスID番号.
 *  @param  [out]   sts     メールボックス状態を格納する構造体のポインタ.
 *
 *  @retval エラーコード.
 */
ER      wi_RefarenceMailBox( INT id, WIMBXSTAT *sts )
{
    ER          ercd;
    WIMBXOBJ    *p;

    //! メールボックスIDのオブジェクトを取得する.
    p = (WIMBXOBJ *)wi_FindObject( id, TMAX_MAXMBX, ObjList, &ercd );
    if( !p ){
        return ercd;
    }
    //! メールボックスの状態を構造体にセットする.
    sts->WaitId  = wi_GetWaitTaskListFirstId( p->WaitQue );
    sts->NextMsg = p->MsgQue;
    sts->ExtInfo = p->ExtInfo;
    return E_OK;
}
	

メールボックス状態を取得する関数は以下のような処理を行います。

  • 引数で指定されたメールボックスID番号に該当するメールボックス・オブジェクトを取り出します。
  • メッセージ受信待ち行列から先頭のタスクのID番号を取り出して、引数の構造体にセットします。
  • メッセージ・パケット・リストの先頭のメッセージ・パケットのポインタを引数の構造体にセットします。
  • cre_mbx()でメールボックスを生成するときに渡された拡張情報を引数の構造体にセットします。(Ver4.0の場合は常に0を返します。)


Windowsは米国Microsoft Corporationの登録商標です。