VWED_server/docs/sc/Websocket相关.md

79 lines
1.5 KiB
Markdown

## Websocket
### 根据 IP 向客户端发送消息
- **方法说明**
根据 IP 向客户端发送消息。
```python
def send_msg_to_wsc_by_client_ip(msg: str, ip: str) -> None
```
- **输入参数**
- `msg`:字符串类型,表示要发送的消息。
- `ip`:字符串类型,表示接收消息的客户端 IP。
- **输出参数**
- 无。
- **异常**
- 本方法会抛出异常。
---
### 根据客户端名称向客户端发送消息
- **方法说明**
根据客户端名称向客户端发送消息。
```python
def send_msg_to_wsc_by_client_name(msg: str, client_name: str) -> None
```
- **输入参数**
- `msg`:字符串类型,表示要发送的消息。
- `client_name`:字符串类型,表示接收消息的客户端名称。
- **输出参数**
- 无。
- **异常**
- 本方法会抛出异常。
---
### 获取所有客户端 IP
- **方法说明**
获取所有 WebSocket 客户端的 IP。
```python
def get_websocket_client_ip() -> list[str]
```
- **输入参数**
- 无。
- **输出参数**
- 返回一个字符串列表,包含所有客户端的 IP。
- **异常**
- 本方法会抛出异常。
---
### 获取所有客户端名称
- **方法说明**
获取所有 WebSocket 客户端名称。
```python
def get_websocket_client_name() -> list[str]
```
- **输入参数**
- 无。
- **输出参数**
- 返回一个字符串列表,包含所有客户端名称。
- **异常**
- 本方法会抛出异常。
---