Skip to content

Commit

Permalink
Ready v3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
sirn-se committed Sep 28, 2024
1 parent a621943 commit 5488e59
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* Server `setContext()` method (@sirn-se)
* RSV flags on Frame (@sirn-se)
* Fixed various typos and broken links (@pieterocp)
* `phrity/net-stream v2.1` for context support and select warning hanling (@sirn-se)
* `phrity/net-stream v2.1` for context support and select warning handling (@sirn-se)
* Deprecation warnings (@sirn-se)

## `v3.1`
Expand Down
19 changes: 10 additions & 9 deletions docs/Class_Synopsis.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,9 @@ class WebSocket\Server implements Psr\Log\LoggerAwareInterface, Stringable
public function setFrameSize(int $frameSize): self;
public function getFrameSize(): int;
public function getPort(): int;
public function getScheme(): string:
public function getScheme(): string;
public function isSsl(): bool;
public function setContext(array $context): self;
public function getConnectionCount(): int;
public function getConnections(): array;
public function getReadableConnections(): array;
Expand Down Expand Up @@ -185,7 +186,7 @@ class WebSocket\Connection implements Psr\Log\LoggerAwareInterface, Stringable
```php
class WebSocket\Exception\BadOpcodeException extends WebSocket\Exception\Exception implements WebSocket\Exception\MessageLevelInterface
{
public function __construct(string $message = '');
public function __construct(string $message = 'Bad Opcode');
}
```

Expand All @@ -194,7 +195,7 @@ class WebSocket\Exception\BadOpcodeException extends WebSocket\Exception\Excepti
```php
class WebSocket\Exception\BadUriException extends WebSocket\Exception\Exception
{
parent::__construct($message ?: 'Bad URI');
public function __construct(string $message = 'Bad URI');
}
```

Expand Down Expand Up @@ -254,7 +255,7 @@ class WebSocket\Exception\ConnectionTimeoutException extends WebSocket\Exception
### Exception

```php
abstract class Exception extends RuntimeException
abstract class WebSocket\Exception\Exception extends RuntimeException
{
}
```
Expand Down Expand Up @@ -306,7 +307,7 @@ class WebSocket\Frame\FrameHandler implements LoggerAwareInterface, Stringable
public function __toString(): string;
public function setLogger(Psr\Log\LoggerInterface $logger): void;
public function pull(): WebSocket\Frame\Frame;
public function push(WebSocket\Frame\Frame $frame, bool|null $masked = null): int;
public function push(WebSocket\Frame\Frame $frame): int;
}
```

Expand All @@ -315,9 +316,12 @@ class WebSocket\Frame\FrameHandler implements LoggerAwareInterface, Stringable
```php
class WebSocket\Frame\Frame implements Stringable
{
public function __construct(string $opcode, string $payload, bool $final);
public function __construct(string $opcode, string $payload, bool $final, bool $rsv1 = false, bool $rsv2 = false, bool $rsv3 = false);
public function __toString(): string;
public function isFinal(): bool;
public function getRsv1(): bool;
public function getRsv2(): bool;
public function getRsv3(): bool;
public function isContinuation(): bool;
public function getOpcode(): string;
public function getPayload(): string;
Expand All @@ -334,7 +338,6 @@ class WebSocket\Http\HttpHandler implements LoggerAwareInterface, Stringable
{
public function __construct(Phrity\Net\SocketStream $stream, bool $ssl = false);
public function __toString(): string;
public function setLogger(Psr\Log\LoggerInterface $logger): void;
public function pull(): Psr\Http\Message\MessageInterface;
public function push(Psr\Http\Message\MessageInterface $message): Psr\Http\Message\MessageInterface;
}
Expand Down Expand Up @@ -417,8 +420,6 @@ class WebSocket\Message\Close extends WebSocket\Message\Message
public function __construct(int|null $status = null, string $content = '');
public function getCloseStatus(): int|null;
public function setCloseStatus(int|null $status): void;
public function getPayload(): string;
public function setPayload(string $payload = ''): void;
}
```

Expand Down
7 changes: 4 additions & 3 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ Base your patch on corresponding version branch, and target that version branch

| Version | Branch | PHP | Status |
| --- | --- | --- | --- |
| [`3.2`](https://github.com/sirn-se/websocket-php/tree/3.2.0) | `v3.2-main` | `^8.1` | Upcoming version |
| [`3.1`](https://github.com/sirn-se/websocket-php/tree/3.1.0) | `v3.1-main` | `^8.1` | Current version |
| [`3.0`](https://github.com/sirn-se/websocket-php/tree/3.0.0) | `v3.0-main` | `^8.1` | Bug fixes only |
| [`3.3`](https://github.com/sirn-se/websocket-php/tree/3.3.0) | `v3.3-main` | `^8.1` | Upcoming version |
| [`3.2`](https://github.com/sirn-se/websocket-php/tree/3.2.0) | `v3.2-main` | `^8.1` | Current version |
| [`3.1`](https://github.com/sirn-se/websocket-php/tree/3.1.0) | `v3.1-main` | `^8.1` | Bug fixes only |
| [`3.0`](https://github.com/sirn-se/websocket-php/tree/3.0.0) | - | `^8.1` | Not supported |
| [`2.2`](https://github.com/sirn-se/websocket-php/tree/2.2.0) | `v2.2-main` | `^8.0` | Bug fixes only |
| [`2.1`](https://github.com/sirn-se/websocket-php/tree/2.1.0) | - | `^8.0` | Not supported |
| [`2.0`](https://github.com/sirn-se/websocket-php/tree/2.0.0) | - | `^8.0` | Not supported |
Expand Down
4 changes: 2 additions & 2 deletions src/Exception/BadOpcodeException.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
*/
class BadOpcodeException extends Exception implements MessageLevelInterface
{
public function __construct(string $message = '')
public function __construct(string $message = 'Bad Opcode')
{
parent::__construct($message ?: 'Bad Opcode');
parent::__construct($message);
}
}
4 changes: 2 additions & 2 deletions src/Exception/BadUriException.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
*/
class BadUriException extends Exception
{
public function __construct(string $message = '')
public function __construct(string $message = 'Bad URI')
{
parent::__construct($message ?: 'Bad URI');
parent::__construct($message);
}
}

0 comments on commit 5488e59

Please sign in to comment.