Houdini 19.5 hwebserver

hwebserver.registerOpdefPath function

指定したプリフィックスを、opdefリクエストを送信するハンドラーとして使用するようにHoudiniのウェブサーバーに命令します。

registerOpdefPath("/opdef", port=-1)

サーバーがprefixで始まるパスのリクエストを受信すると、サーバーはそれに該当するopdefセクションデータで応答します。 ハンドラーをサーバーのメインポート以外のポートで実行させたい場合は、オプションでportを指定することができます。

この関数は、URLハンドラーからコールするのではなく、hwebserver.runコールの前にコールしてください。

例えば、以下を実行して:

hwebserver.registerOpdefPath("/opdef")

…クライアントが以下のサーバーパスをリクエストした場合:

/opdef/obj/geo?Help

…サーバーは、自動的にgeoノードからHelpセクションのデータを提供します。

Note

URLハンドラーがopdefパスプリフィックスよりも特定された(もっと多くのパス部分にマッチする)URLを持っている場合、サーバーは、opdef検索の代わりにそのハンドラーを使用します。

例えば、上記のようにopdefを登録したとしても、クライアントが/opdef/geo/foo.bgeoをリクエストし、/opdef/geoに対して動的ハンドラーがある場合、 サーバーは、opdefハンドラーを使用せず、その動的ハンドラーを使用します。

これは、静的なopdefハンドラーと混在して動的に生成されるopdefハンドラーがいくつか必要な場合に役立ちます。 とはいえ、通常では、混乱を避けるために、opdefセクションリクエストに対してデフォルトの/opdefプリフィックスを使用するなどして、opdefリソースと動的リソースを分けるのが良いです。

See also

hwebserver

クラス

  • hwebserver.Request

    Houdiniのウェブサーバーに送信されるリクエスト。

  • hwebserver.Response

    Houdiniのウェブサーバーから送り返されるレスポンス。

  • hwebserver.UploadedFile

    Houdiniのウェブサーバーに送信されるリクエストにアップロードされたファイル。

  • URLHandler

    汎用のHTTPハンドラー。

  • AsyncURLHandler

    汎用の非同期HTTPハンドラー。

  • WebSocket

    組み込みサーバーをWebSocketに対応させるための基本クラス。

開始と停止

  • hwebserver.run

    Houdiniのウェブサーバーを開始します。

  • hwebserver.requestShutdown

    すべてのオープンリクエストが処理された後にシャットダウンするようにHoudiniのウェブサーバーに命令します。

  • hwebserver.isInDebugMode

    Houdiniのウェブサーバーがデバッグモード(でdebug=True)で起動されていればTrueを返します。

ウェブリクエストの処理とレスポンスの返し

  • hwebserver.urlHandler

    Houdiniのウェブサーバーへのリクエストを制御する関数のデコレータ。

  • hwebserver.errorResponse

    HTTPエラーを表現したResponseオブジェクトを生成します。

  • hwebserver.notFoundResponse

    404 Not Found HTTPエラーを表現したResponseオブジェクトを生成します。

  • hwebserver.fileResponse

    ファイルの内容を送信するResponseオブジェクトを生成します。

  • hwebserver.redirect

    301 Movedまたは302 FoundのHTTPレスポンスを表現したResponseオブジェクトを生成します。

  • hwebserver.registerStaticFilesDirectory

    指定したプリフィックスにマッチしたURLに対して自動的にファイルを提供するために、指定したディレクトリをチェックするようにHoudiniのウェブサーバーに命令します。

  • hwebserver.registerOpdefPath

    指定したプリフィックスを、opdefリクエストを送信するハンドラーとして使用するようにHoudiniのウェブサーバーに命令します。

  • hwebserver.registerWSGIApp

    パスプリフィックスで使用するDjangoなどのWSGI準拠のアプリケーションを登録する際に使用する関数。

  • hwebserver.registerASGIApp

    パスプリフィックスで使用するDjangoなどのASGI準拠のアプリケーションを登録する際に使用する関数。

  • hwebserver.setSettingsForPort

    特定のポートの設定を調整します。

ウェブソケット

  • WebSocket

    組み込みサーバーをWebSocketに対応させるための基本クラス。

  • hwebserver.webSocket

    HoudiniのウェブサーバーにWebSocketクラスを登録するデコレータ。

APIコール

  • hwebserver.apiFunction

    Houdiniウェブサーバー上のAPIエンドポイント経由で関数をコールを可能にするデコレータで、JSON形式またはバイナリ形式のレスポンスを返します。

  • hwebserver.APIError

    apiFunctionハンドラー内でこの例外を引き起こしてエラーを示します。