Houdini 19.5 hwebserver

hwebserver.setSettingsForPort function

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

setSettingsForPort(settings, port_name="")

この関数は、特定のポートの設定を調整することができます。

PORT

リッスンするポート番号。

MAX_PORT

これを指定すると、サーバーは、PORTからここで指定したMAX_PORTまでポートの検索を試みます。 サーバーは、利用可能なポートが見つかると、そこで検索を停止します。

ALLOW_SYSTEM_PORT

ポート範囲内で利用可能なポートが見つからなかった場合、システム側でポートを拾わせることができます。

ADDRESS

サーバーにバインドさせるアドレス。 デフォルトは任意のアドレスです(つまり、0.0.0.0)。

IPV6

IPv6サポートを有効にします。

ALLOWED_HOSTS

サーバーと通信が許可されるホストのリスト。 これは、ホストヘッダ攻撃を防ぐためのセキュリティ対策です。 デフォルトでは、すべてのホストが許可されています。

USE_X_FORWARDED_HOST

Hostヘッダの代わりにX-Forwarded-Hostヘッダを使用するかどうかを指定したブール値。 デフォルトはFalseです。

LOG_FILE

このポートからのすべての情報もログに残すログファイル。

MIN_LOG_SEVERITY

最低重要度エントリーがログファイルに書き出されます。 デフォルトはhwebserver.WarningSeverityです。

SSL_CERTIFICATE

サーバーが使用するSSL証明書チェーン。

SSL_CERTIFICATE_KEY

サーバーが使用するプライベートキー。 このキーはPEMフォーマットでなければなりません。

SSL_DH_PARAMS

サーバーが使用するDiffie-Hellman(DH)パラメータ。

SSL_VERIFY_PEER

HTTPSを使用する際にサーバーがピアを検証するかどうか。 デフォルトはTrueです。

SSL_REDIRECT

HTTPリクエストを受信した時に、そのリクエストがHTTPSにリダイレクトされます。 リクエストにUpgrade-Insecure-Requests: "1"ヘッダが含まれていない場合、サーバーは、そのリクエストを403(Forbidden)で拒否します。

SSL_REDIRECT_HOST

安全でないリクエストをリダイレクトする時に、そのリクエスト内のホストの代わりにこのホストを使用します。 SSL_REDIRECTがFalseの場合、これは何の効果もありません。

SSL_REDIRECT_EXEMPT

HTTPSへのリダイレクトが免除されるホストのリスト。 SSL_REDIRECTがFalseの場合、これは何の効果もありません。

SECURE_HSTS_SECONDS

クライアントがHTTPSからでしかアクセスできないパスを記憶する秒数。 デフォルトは0です。

SECURE_HSTS_INCLUDE_SUBDOMAINS

これをTrueに設定すると、すべてのサブドメインがHTTPS経由でしかアクセスできないように扱われます。 デフォルトはFalseです。

SECURE_HSTS_PRELOAD

これをTrueに設定すると、クライアントは安全でないリクエストの使用をまったく試みなくなります。 デフォルトはFalseです。

SECURE_CONTENT_TYPE_NOSNIFF

これをTrueに設定すると、X-Content-Type-Options: nosniffがレスポンスに追加されます。 これは、いわゆるファイルダウンロード駆動による攻撃を防ぎます。 デフォルトはTrueです。

SECURE_REFERRER_POLICY

これを設定すると、Referrer Policyがこのヘッダにまだ設定されていないすべてのレスポンスに追加されます。 デフォルトはsame-originです。

SECURE_CROSS_ORIGIN_OPENER_POLICY

これを設定すると、XS-Leaksと呼ばれる一連のクロスオリジン攻撃を防ぐのに役立ちます。 この設定を指定すると、まだCross-Origin-Opener-Policyが設定されていなければ、それが設定されます。 デフォルトはsame-originです。

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ハンドラー内でこの例外を引き起こしてエラーを示します。