webSocket(path, is_prefix=False, ports=[])
Note
WebSocket対応はPython3のみです。
このデコレータでクラスをデコレートすると、そのクラスは、指定したサーバーパスのウェブサーバーに登録されます。
path
"/"で始まる文字列を指定しますが、末尾はスラッシュで終わっても終わらなくても構いません。
pathが登録される時、末尾のスラッシュはサーバーの挙動に何も影響を与えません。
もしpathにスラッシュがなくても、暗黙的に追加され、サーバーがパスとリクエストハンドラーをマッチさせる時には、サーバリクエストに送信されたパスにスラッシュがなければ追加されます。
is_prefix
Falseの場合、リクエストされたパスがpathに一致した場合にのみクラスが作成されます。
しかし、Trueの場合、リクエストされたパスがpathで始まり、その後にスラッシュで、その後に何かになっていればクラスが作成されます。
ports
WebSocketクラスを作成可能なポート。
ポートを指定しなかった場合、クラスはウェブサーバーのメインポートにバインドされます。
ポート名は、空っぽでなく、且つ、main(メインポートに予約済みの名前)でなければ、どのような名前でも構いません。
| See also |