Skip to content

Commit 349eae9

Browse files
committed
Update README
1 parent e062ad9 commit 349eae9

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ A simple echo server:
77
```php
88
use Ratchet\RFC6455\Messaging\Message;
99
use React\EventLoop\Factory;
10-
use React\Http\MiddlewareRunner;
1110
use React\Http\Server;
1211
use Voryx\WebSocketMiddleware\WebSocketConnection;
1312
use Voryx\WebSocketMiddleware\WebSocketMiddleware;
@@ -28,3 +27,16 @@ $server->listen(new \React\Socket\Server('127.0.0.1:4321', $loop));
2827

2928
$loop->run();
3029
```
30+
# Options
31+
By default `WebSocketMiddleware` uses the `ratchet/rfc6455` default max sizes for messages and frames and also disables compression.
32+
These settings can be overridden with the `WebSocketOptions` object.
33+
```php
34+
$ws = new WebSocketMiddleware(
35+
[],
36+
$connectionHandler,
37+
[],
38+
WebSocketOptions::getDefault()
39+
->withMaxFramePayloadSize(2048)
40+
->withMaxMessagePayloadSize(4096)
41+
->withPermessageDeflate());
42+
```

0 commit comments

Comments
 (0)