一款基于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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca8905c0a73a81aace8a9b4fe8f3a50a4cd6757481dbaadff09024a2e84edd40 |
|
MD5 | 9065ec24b23b4de4146f21589789fa36 |
|
BLAKE2b-256 | e22e5aed0cc56764d20f4282c92ee0427c4dd52c6b64efe417ffa6cae4d03ded |
Close
Hashes for CheeseAPI_Websocket-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c1c18828fbdce340d27504a0c722de49c973c0877964d0503e8b6facc315a39 |
|
MD5 | d5b879b4d6944c9c75c23447ef6f4bf2 |
|
BLAKE2b-256 | fa9e29f4e04b127f3d7401163fd9ea31b3b900d168d0e4c5412530fdaa286777 |