Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ratchetphp/Ratchet
Asynchronous WebSocket server
https://github.com/ratchetphp/Ratchet
async php ratchet websocket websockets
Last synced: about 2 months ago
JSON representation
Asynchronous WebSocket server
- Host: GitHub
- URL: https://github.com/ratchetphp/Ratchet
- Owner: ratchetphp
- License: mit
- Created: 2012-04-16T21:53:21.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T02:48:04.000Z (9 months ago)
- Last Synced: 2024-04-14T17:05:15.376Z (8 months ago)
- Topics: async, php, ratchet, websocket, websockets
- Language: PHP
- Homepage: http://socketo.me
- Size: 1.22 MB
- Stars: 6,148
- Watchers: 219
- Forks: 692
- Open Issues: 198
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-php - Ratchet - A web socket library. (Table of Contents / Event)
- awesome-php-cn - Ratchet - 图书馆网络套接字. (目录 / 事件 Event)
- awesome-projects - Ratchet - A web socket library. (PHP / Event)
- php-awesome - Ratchet - 创建实时、双向客户端服务器 WebSockets 应用 (类库 / 未归类)
- awesome-php - Ratchet - A web socket library. (Table of Contents / Event)
README
# Ratchet
[![GitHub Actions][GA Image]][GA Link]
[](http://socketo.me/reports/ab/index.html)
[](https://packagist.org/packages/cboden/ratchet)
A PHP library for asynchronously serving WebSockets.
Build up your application through simple interfaces and re-use your application without changing any of its code just by combining different components.
## Reviving Ratchet!
We're currently aiming to revive Ratchet to get it up to date with the latest versions and use this as a starting point for bigger updates to come.
We need your help to achieve this goal, see [ticket #1054](https://github.com/ratchetphp/Ratchet/issues/1054) for ways to help out. ❤️
## Requirements
Shell access is required and root access is recommended.
To avoid proxy/firewall blockage it's recommended WebSockets are requested on port 80 or 443 (SSL), which requires root access.
In order to do this, along with your sync web stack, you can either use a reverse proxy or two separate machines.
You can find more details in the [server conf docs](http://socketo.me/docs/deploy#server_configuration).
### Documentation
User and API documentation is available on Ratchet's website: http://socketo.me
See https://github.com/cboden/Ratchet-examples for some out-of-the-box working demos using Ratchet.
Need help? Have a question? Want to provide feedback? Write a message on the [Google Groups Mailing List](https://groups.google.com/forum/#!forum/ratchet-php).
---
### A quick example
```php
clients = new \SplObjectStorage;
}
public function onOpen(ConnectionInterface $conn) {
$this->clients->attach($conn);
}
public function onMessage(ConnectionInterface $from, $msg) {
foreach ($this->clients as $client) {
if ($from != $client) {
$client->send($msg);
}
}
}
public function onClose(ConnectionInterface $conn) {
$this->clients->detach($conn);
}
public function onError(ConnectionInterface $conn, \Exception $e) {
$conn->close();
}
}
// Run the server application through the WebSocket protocol on port 8080
$app = new Ratchet\App('localhost', 8080);
$app->route('/chat', new MyChat, array('*'));
$app->route('/echo', new Ratchet\Server\EchoServer, array('*'));
$app->run();
```
$ php chat.php
```javascript
// Then some JavaScript in the browser:
var conn = new WebSocket('ws://localhost:8080/echo');
conn.onmessage = function(e) { console.log(e.data); };
conn.onopen = function(e) { conn.send('Hello Me!'); };
```
[GA Image]: https://github.com/ratchetphp/Ratchet/workflows/CI/badge.svg
[GA Link]: https://github.com/ratchetphp/Ratchet/actions?query=workflow%3A%22CI%22+branch%3Amaster