一款基于CheeseAPI的升级款Websocket插件。
Project description
CheeseAPI_Websocket
介绍
一款基于CheeseAPI的升级款Websocket插件,它能够解决在多worker下websocket的通讯问题,前提是需要引入redis。
安装
目前仅保证支持3.11及以上的python。
pip install CheeseAPI_Websocket
使用
CheeseAPI_Websocket是CheeseAPI的一款插件,它需要依赖于CheeseAPI才能运行。
import threading, time
from CheeseAPI import app, WebsocketClient, Response
from CheeseAPI_Websocket import websocket
app.modules = [ 'CheeseAPI_Websocket' ] # 加入模块
websocket.init() # 初始化redis连接
@app.route.websocket('/')
class Test(WebsocketClient):
...
# 创建一个线程,在非协程环境下发送Websocket
@app.handle.server_afterStartingHandle
def test():
def test0():
while True:
websocket.send('/', '你好')
time.sleep(1)
threading.Thread(target = test, daemon = True).start()
# 在协程环境下发送Websocket
@app.route.post('/websocket')
async def test1():
await websocket.async_send('/', '世界')
return Response()
if __name__ == '__main__':
app.run()
若传输的数据量过大,请使用原生的send方法,以避免为redis带来过大的负担。
Websocket
from CheeseAPI_Websocket import websocket
websocket.init(host: IPv4 = app.server.host, port: Port = 6379, db: NonNegativeInt = 0)
初始化redis连接。
websocket.send(path: str, message: str | bytes | dict | list, sid: str | List[str] | Literal['*'] = '*')
发送消息,支持广播。
await websocket.async_send(path: str, message: str | bytes | dict | list, sid: str | List[str] | Literal['*'] = '*')
发送消息,支持广播。
websocket.close(path: str, sid: str | List[str] | Literal['*'] = '*')
关闭连接,支持广播。
await websocket.async_close(path: str, sid: str | List[str] | Literal['*'] = '*')
关闭连接,支持广播。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for cheeseapi_websocket-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cda1d87ce81920180a26a323aa34ff1459563464a9fe5e2cc0422275e4782b2 |
|
MD5 | ddb55dd1ab1341c711ca736ae0a785e3 |
|
BLAKE2b-256 | 5b4df008167b3ebfbdf8b3e9442ccf3002935f3a03491ee5cadf7b6c37caa3b8 |
Close
Hashes for cheeseapi_websocket-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12291f679674b7d9b69fbf5e175e1f1e3340bc110b853e04debd33fe1b22b892 |
|
MD5 | 446b3f4089b3b965e45692fa68257cd5 |
|
BLAKE2b-256 | 64f86fba89ca3b0aa3077065c1c54766c1d3e7d7b84213aa8ffb8b7dbcbae5b4 |