FilesExpand file tree

 main

/

asgi.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

47 lines (40 loc) · 2.14 KB

 main

/

asgi.py

Copy path

Top

File metadata and controls

• Code
• Blame

47 lines (40 loc) · 2.14 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

import engineio

class ASGIApp(engineio.ASGIApp): # pragma: no cover

"""ASGI application middleware for Socket.IO.

This middleware dispatches traffic to an Socket.IO application. It can

also serve a list of static files to the client, or forward unrelated

HTTP traffic to another ASGI application.

:param socketio_server: The Socket.IO server. Must be an instance of the

``socketio.AsyncServer`` class.

:param static_files: A dictionary with static file mapping rules. See the

documentation for details on this argument.

:param other_asgi_app: A separate ASGI app that receives all other traffic.

:param socketio_path: The endpoint where the Socket.IO application should

be installed. The default value is appropriate for

most cases. With a value of ``None``, all incoming

traffic is directed to the Socket.IO server, with the

assumption that routing, if necessary, is handled by

a different layer. When this option is set to

``None``, ``static_files`` and ``other_asgi_app`` are

ignored.

:param on_startup: function to be called on application startup; can be

coroutine

:param on_shutdown: function to be called on application shutdown; can be

coroutine

Example usage::

import socketio

import uvicorn

sio = socketio.AsyncServer()

app = socketio.ASGIApp(sio, static_files={

'/': 'index.html',

'/static': './public',

})

uvicorn.run(app, host='127.0.0.1', port=5000)

"""

def __init__(self, socketio_server, other_asgi_app=None,

static_files=None, socketio_path='socket.io',

on_startup=None, on_shutdown=None):

super().__init__(socketio_server, other_asgi_app,

static_files=static_files,

engineio_path=socketio_path, on_startup=on_startup,

on_shutdown=on_shutdown)