WSSetYieldFunction （C 関数）

int WSSetYieldFunction(WSLINK link,WSYieldFunctionObject yf)

降伏関数 yf を link で参照されるリンクのためにインストールする．

詳細

  • WSTPのAPIの呼出しは，データが読取りに使えるようになるか，あるいは書込みに必要な容量ができるようになるまで，阻止されることがある．その阻止時間中にアプリケーションで他の有用な処理を行う必要がある場合は，そのアプリケーションにリンクのための降伏関数をインストールすれば，WSTPが自動的に阻止時間中に降伏関数の呼出しを行うようになる．
  • 阻止された読取りや書込みを取り消すためには，降伏関数はゼロ以外の値を返すべきである．
  • WSSetYieldFunction()はエラーがあると0を返し，関数が成功するとゼロ以外の値を返す．
  • Windowsでは，WSYieldFunctionObjectはWINAPI呼出し規則を使う．
  • WSError()を使うと，WSSetYieldFunction()が不成功の場合にエラーコードを引き出すことができる．
  • WSSetYieldFunction()は，WSTPヘッダファイルwstp.hの中で宣言される．

例題

例  (1)

#include "wstp.h"

#if UNIX_WSTP
#    define CALLING_CONVENTION
#elif WINDOWS_WSTP
#    define CALLING_CONVENTION WINAPI
#endif

int CALLING_CONVENTION AppYieldFunction(WSLINK lp, WSYieldParameters yp)
{
    /* ... */
    return 0;
}

int main(int argc, char **argv)
{
    WSENV env;
    WSLINK link;
    int error;

    env = WSInitialize((WSEnvironmentParameter)0);
    if(env == (WSENV)0)
        { /* unable to initialize WSTP environment */ }

    link = WSOpenArgcArgv(env, argv, argv + argc, &error);
    if(link == (WSLINK)0 || error != WSEOK)
        { /* unable to create the link */ }

    if(! WSSetYieldFunction(link, AppYieldFunction))
        { /* unable to set the yield function for link */ }

    /* ... */

    WSClose(link);
    WSDeinitialize(env);
    return 0;
}