WSTPServer

名前

wstpserver 今後のWSTP接続についてWolfram言語カーネルを起動,管理するサーバプログラム.

概要

wstpserver [--port port] [--interface interface]

説明

WSTPServerはカーネルとカーネルプールを管理する.

WSTPServerは,クライアントからそれを管理するカーネルへのすべてのトラフィックを転送し,WSTPServerへのリンクがカーネルへの直接のリンクのように動作できるようにする.この過程は高度に設定可能である.例えば,クライアントは前に接続したカーネルに接続したり,接続のたびに別のカーネルに接続したりできる.Null

オプション

WSTPServerのコマンドラインオプションは以下の通りである.

  • -h, --helpヘルプテキストを表示する
    -l, --log-level nメッセージの冗長性レベルを指定する
    -f, --log-file [file]指定されたファイルにメッセージを書く
    -a, --advertise [service]存在する場合には,リンクサーバを指定のサービスとして公表する
    -p, --port port指定のポートを受信待機にする
    -i, --interface interface指定のインターフェースを受信待機にする
    -c, --configuration-file file指定の設定ファイルを使う
  • 3つのレベルの--log-level-lの冗長性は以下の通りである.

  • error, 1サーバの起動または停止のエラーを報告し,起動成功のメッセージを表示する
    debug, 2レベル1からすべて,およびすべてのデバッグメッセージを報告する
    trace, 3レベル2からすべて,および処理されたWSTPトラフィックすべてを報告する
  • --log-levelまたは-lが使用されていない場合,デフォルトのログ冗長性はerrorに設定される.

    --log-fileまたは-fが使用されていない場合,またはファイルを指定せずに使われている場合には,メッセージはstdoutに書かれる.

    --advertise [service] または-a [service]が使われる場合,WSTPServerは service が指定されているかによって,自らをWSTPServer-InstanceまたはWSTPServer-Instance-service として公表しようとする.WSTPServerは,それが公表されるサービス名をログする.

    --advertiseまたは-aが使われていない場合,リンクサーバは公表されない.

    --portまたは-pが使われていない場合,リンクサーバはポート31415を受信待機にする.

    --interfaceまたは-iが使われていない場合,リンクサーバはデフォルトのネットワークインターフェースを受信待機にする.インターフェースをlocalhostに設定して,WSTPServerがローカルネットワークで見えないようにする.

    --configuration-fileまたは-cが使われていない場合,リンクサーバはデフォルトの設定ファイルの検索動作と使用を使う.

    詳細

    より詳しい情報については,「WSTPServer入門」を参照されたい.

    例題

    簡単なコマンドでWSTPServerを起動する:

    $ wstpserver
    
    WSTPServer: Logger (0, 2020-09-29 16:50:00): Information: 
        Using "/Applications/Mathematica.app/Contents/MacOS/WolframKernel" as a default kernel path
    
    WSTPServer: Logger (0, 2020-09-29 16:50:05): Information: 
        Listening for new connections on port 31415
    
    ...

    ループバックインターフェースで,ポート12345上で待機状態になるように,WSTPServerを起動する:

    $ wstpserver --port 12345 --interface 127.0.0.1
    
    WSTPServer: Logger (0, 2020-09-29 16:54:25): Information: 
        Using "/Applications/Mathematica.app/Contents/MacOS/WolframKernel" as a default kernel path
    
    WSTPServer: Logger (0, 2020-09-29 16:54:29): Information: 
        Listening for new connections on port 12345 and interface 127.0.0.1
    
    ...

    ファイル

    デフォルトの設定ファイル:

  • %APPDATA%\WSTPServer\wstpserver.conf
    Windows
    ~/Library/Application Support/WSTPServer/wstpserver.conf
    Macintosh
    ~/.config/WSTPServer/wstpserver.conf
    Linux
  • より詳しい情報については,「WSTPServer入門」「設定ファイル」のセクションを参照されたい.

    WOLFRAM言語関数

    WSTPServer`StartKernel カーネルを(任意のプールの外側で)起動し,そのIDを返す.

    WSTPServer`CloseKernel カーネルを閉じる.

    WSTPServer`ConnectKernel 現行の接続を指定のカーネルにブリッジする.

    WSTPServer`DisconnectKernel ブリッジされたカーネルとの現行の接続を破棄する.

    WSTPServer`SetKeepAlive 現行の接続が停止またはブリッジが終了したときに,現行の接続にブリッジされたカーネルを閉じるかどうかを設定する.

    WSTPServer`SetAllowSilentKernelReplacement カーネルが停止した場合に,現行の接続にブリッジされたカーネルの再起動をサイレントモードで行うことを許可するかしないかを設定する.

    WSTPServer`GetKernelID 現行の接続にブリッジされたカーネルのID.

    WSTPServer`GetPoolName 現行の接続にブリッジされたカーネルのプールの名前を得る.

    WSTPServer`GetServerInformation すべてのプールとカーネルについての情報を得る.

    WSTPServer`GetServerInformation 現行のカーネルのブリッジが破棄されたときに,IDでリクエストしたクライアントにだけブリッジできるかどうかを設定する.

    より詳しい情報については,「WSTPServer入門」「コマンド言語」のセクションを参照されたい.

    環境変数

    WSTPSERVER_CONFIGURATION_FILE デフォルトの設定ファイルの検索動作の代りに使う特定の設定ファイルへのパス.

    WSTPSERVER_PORT 設定されると,リンクサーバが受信待機にするポート.

    WSTPSERVER_INTERFACE 設定されると,リンクサーバが受信待機にするインターフェース.

    WSTPSERVER_DISABLE_ADVERTISING 設定されると,リンクサーバの公表を無効にする.

    設定変数

    可能な設定変数と詳細については,「WSTPServer入門」「設定ファイル」のセクションを参照されたい.