Skip to content

Commit 7cc84bd

Browse files
Option to disable routing in ASGIApp
1 parent e8bab71 commit 7cc84bd

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/socketio/asgi.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@ class ASGIApp(engineio.ASGIApp): # pragma: no cover
1515
:param other_asgi_app: A separate ASGI app that receives all other traffic.
1616
:param socketio_path: The endpoint where the Socket.IO application should
1717
be installed. The default value is appropriate for
18-
most cases.
18+
most cases. With a value of ``None``, all incoming
19+
traffic is directed to the Socket.IO server, with the
20+
assumption that routing, if necessary, is handled by
21+
a different layer. When this option is set to
22+
``None``, ``static_files`` and ``other_asgi_app`` are
23+
ignored.
1924
:param on_startup: function to be called on application startup; can be
2025
coroutine
2126
:param on_shutdown: function to be called on application shutdown; can be
@@ -27,7 +32,7 @@ class ASGIApp(engineio.ASGIApp): # pragma: no cover
2732
import uvicorn
2833
2934
sio = socketio.AsyncServer()
30-
app = engineio.ASGIApp(sio, static_files={
35+
app = socketio.ASGIApp(sio, static_files={
3136
'/': 'index.html',
3237
'/static': './public',
3338
})

0 commit comments

Comments
 (0)