WSSetMessageHandler (C 関数)

int WSSetMessageHandler(WSLINK link,WSMessageHandlerObject h)

link のために h で参照される緊急メッセージハンドラ(処理)関数をインストールする.

詳細

  • WSTPが接続の向こう側から緊急のメッセージを受けると,緊急メッセージハンドラ関数が呼び出される.
  • WSSetMessageHandler()はエラーがあると0を返し, 関数が成功すると0以外の値を返す.
  • WSError()を使うと,WSSetMessageHandler()が不成功の場合にエラーコードを引き出すことができる.
  • WSMessageHandlerObjectは,void f(WSLINK link,int m1,int m2)の形の関数のポインタである.
  • WSSetMessageHandler()は,WSTPヘッダファイルwstp.hの中で宣言される.

例題

  (1)

#include "wstp.h"


/* handle three common WSTP urgent messages */

void f(WSLINK lp, int msg, int arg)
{
    if(msg == WSInterruptMessage)
        { /* generate an interrupt menu */ }
    else if(msg == WSAbortMessage)
        { /* abort the current operation */ }
    else if(msg == WSTerminateMessage)
        { /* shutdown the program */ }

    /* ... */
}


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

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

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

    if(! WSSetMessageHandler(link, (WSMessageHandlerObject)f)
        { /* unable to install message handler for link */ }

    /* ... */

    WSClose(link);
    WSDeinitialize(env);

    return 0;
}