WSGetYieldFunction （C 関数）

WSYieldFunctionObject WSGetYieldFunction(WSLINK link)

link で参照されたリンクに対して，現在インストールされている降伏関数を返す．

詳細

  • WSTPのAPIの呼出しは，データが読取りに使えるようになるか，あるいは書込みに必要な容量ができるようになるまで，阻止されることがある．その阻止時間中にアプリケーションで他の有用な処理を行う必要がある場合は，そのアプリケーションにリンクのための降伏関数をインストールすれば，WSTPが自動的に阻止時間中に降伏関数の呼出しを行うようになる．
  • link に降伏関数がインストールされていない場合には，WSGetYieldFunction()は(WSYieldFunctionObject)0を返す．
  • WSGetYieldFunction()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

int AppYieldFunction1 (WSLINK mlp, WSYieldParameters yp)
{
    /* ... */
    return 0;
}

int AppYieldFunction2 (WSLINK mlp, WSYieldParameters yp)
{
    /* ... */
    return 0;
}


/* check which yield function is installed in a link */

int f(WSLINK lp)
{
    WSYieldFunctionObject yf;

    yf = WSGetYieldFunction(lp);
    if(yf == (WSYieldFunctionObject)AppYieldFunction1) return 1;
    else if(yf == (WSYieldFunctionObject)AppYieldFunction2) return 2;
    else if(yf == (WSYieldFunctionObject)0) return 0;

    return -1;    
}