一款基于CheeseAPI的升级款Websocket插件
Project description
CheeseAPI_Websocket
介绍
一款基于CheeseAPI的升级款Websocket插件,它能够解决在多worker下websocket的通讯问题,前提是需要引入redis。
安装
目前仅支持linux python3.11,这里也推荐将python升级到3.11。
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()
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-0.1.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aca7d91a0b03158bc0d06d6bda29aad34a13f2d799211eb896cd4a0ab6dc4baa |
|
MD5 | b6fc65e424a7a7bcb22f1849556d7bc1 |
|
BLAKE2b-256 | a59b5d6bfa526474bc23a6a529139c2c736082ae649be60c63fd7d52dfc4c668 |
Close
Hashes for CheeseAPI_Websocket-0.1.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e18e64684637a7ed3b0691c18d706a7f8e507f099c03c6e90786dd495e6c425 |
|
MD5 | bf3f02825a5dc54fcd1d1519b6ab7543 |
|
BLAKE2b-256 | 93aa3d309bffe53f7b86e07d48ed0101b462fa50dc6ecf840f7e66f687242f8d |