https://github.com/liudding/pigeon
A real-time messaging server built with SocketIO
https://github.com/liudding/pigeon
Last synced: 12 months ago
JSON representation
A real-time messaging server built with SocketIO
- Host: GitHub
- URL: https://github.com/liudding/pigeon
- Owner: liudding
- Created: 2023-05-04T10:24:55.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T06:07:53.000Z (almost 3 years ago)
- Last Synced: 2025-03-15T18:52:02.147Z (over 1 year ago)
- Language: JavaScript
- Size: 250 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Socket
> Made with SocketIO
本项目仅作为 WebSocket 的代理 broker，负责转发客户端与客户端、客户端与服务端之间的事件消息，不参与业务。
### Channels
* public channels
* private channels
* presence channels
* state channels
:join, name
:leave, name
:xxx, {}
### 事件
事件分为系统事件和普通事件，
#### 系统事件
系统事件是 Socket 系统定义的事件，用来处理定义的应用协议（非 WebSocket 协议）。事件名称均为保留词，在定义普通事件时，需确保普通事件名称不能与系统事件重名。
为了减少事件重名的概率，可为系统事件指定前缀，如指定前缀为 `chao`，则系统事件名称则形如 `chao:join_room`。
事件列表：
* join_room
* join_room_succeeded
*
#### 普通事件
普通事件，可以任意定义。
### 事件发送
方式：
* 广播
* 指定对象
### Webhooks
```json
{
"time_ms": 1327078148132,
"events": [{ "name": "event_name", "some": "data" }]
}
```
## Admin UI
https://admin.socket.io/