WSYieldFunctionObject （C 函数）

是一个 WSTP 类型，描述一个把 WSLINK 对象作为一个自变量，WSYieldParameters 对象作为一个自变量并返回一个 int 的函数的函数指针.

更多信息

  • 某些 WSTP API 调用会被阻塞直到数据可被读取或空间可被写入. 如果在阻塞期间，应用程序需要执行其他有用的处理，应用程序可以为链接安装屈服函数（yield function），当被阻塞时，WSTP 会自动调用屈服函数.
  • 备份被封锁的读或写，屈服函数应返回一个非零值.
  • WSYieldParameters 对象是过时的，只是为了维护向后兼容性.
  • 在 Windows 上， WSYieldFunctionObject 使用 WINAPI 调用规范.
  • WSTP 的标头文件 wstp.h 已对 WSYieldFunctionObject 作出声明.

范例

基本范例  (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;
}