Typed properties

docs/Changelog.md

@@ -10,6 +10,7 @@
 
  * Support `psr/log v3` (@sirn-se)
  * Client `receive()` nevere return `null` (@sirn-se)
+ * Typed class properties (@sirn-se)
 
 ## `v2.2`
 

docs/Migrate_2_3.md

@@ -1,5 +1,7 @@
 [Documentation](Index.md) / Migration v2 -> v3
 
+Version 3.x has few changes compared to previous version.
+
 # Breaking changes
 
 ## setLogger
@@ -12,7 +14,8 @@ MiddlewareHandler->setLogger(LoggerInterface $logger): void
 
 These methods now return `void` instead of `self.`
 This means method return can not be chained.
-The change make the comlient with `psr/log v3`.
+
+The change make v3 complient with `psr/log v3`.
 
 ## receive
 
@@ -22,3 +25,7 @@ Client->receive(): Message
 
 The method no longer has `Message|null` as return type.
 It never returned `null` before, so only the method profile has changed.
+
+# Extending
+
+When extending classes in this repo, you might need to implement typed properties in child class.

src/Client.php

@@ -9,6 +9,7 @@
 
 use InvalidArgumentException;
 use Phrity\Net\{
+    StreamCollection,
     StreamFactory,
     Uri
 };
@@ -52,20 +53,20 @@ class Client implements LoggerAwareInterface, Stringable
     use StringableTrait;
 
     // Settings
-    private $logger;
-    private $timeout = 60;
-    private $frameSize = 4096;
-    private $persistent = false;
-    private $context = [];
-    private $headers = [];
+    private LoggerInterface $logger;
+    private int $timeout = 60;
+    private int $frameSize = 4096;
+    private bool $persistent = false;
+    private array $context = [];
+    private array $headers = [];
 
     // Internal resources
-    private $streamFactory;
-    private $socketUri;
-    private $connection;
-    private $middlewares = [];
-    private $streams;
-    private $running = false;
+    private StreamFactory $streamFactory;
+    private Uri $socketUri;
+    private Connection|null $connection = null;
+    private array $middlewares = [];
+    private StreamCollection|null $streams = null;
+    private bool $running = false;
 
 
     /* ---------- Magic methods ------------------------------------------------------------------------------------ */

src/Connection.php

@@ -51,19 +51,19 @@ class Connection implements LoggerAwareInterface, Stringable
     use SendMethodsTrait;
     use StringableTrait;
 
-    private $stream;
-    private $httpHandler;
-    private $messageHandler;
-    private $middlewareHandler;
-    private $logger;
-    private $frameSize = 4096;
-    private $timeout = 60;
-    private $localName;
-    private $remoteName;
-    private $handshakeRequest;
-    private $handshakeResponse;
-    private $meta = [];
-    private $closed = false;
+    private SocketStream $stream;
+    private HttpHandler $httpHandler;
+    private MessageHandler $messageHandler;
+    private MiddlewareHandler $middlewareHandler;
+    private LoggerInterface $logger;
+    private int $frameSize = 4096;
+    private int $timeout = 60;
+    private string $localName;
+    private string $remoteName;
+    private Request|null $handshakeRequest = null;
+    private Response|null $handshakeResponse = null;
+    private array $meta = [];
+    private bool $closed = false;
 
 
     /* ---------- Magic methods ------------------------------------------------------------------------------------ */

src/Exception/CloseException.php

@@ -13,8 +13,8 @@
  */
 class CloseException extends Exception
 {
-    protected $status;
-    protected $content;
+    protected int|null $status;
+    protected string $content;
 
     public function __construct(int|null $status = null, string $content = '')
     {

src/Exception/HandshakeException.php

@@ -15,7 +15,7 @@
  */
 class HandshakeException extends Exception implements ConnectionLevelInterface
 {
-    private $response;
+    private Response $response;
 
     public function __construct(string $message, Response $response)
     {

src/Frame/Frame.php

@@ -18,9 +18,9 @@ class Frame implements Stringable
 {
     use StringableTrait;
 
-    private $opcode;
-    private $payload;
-    private $final;
+    private string $opcode;
+    private string $payload;
+    private bool $final;
 
     public function __construct(string $opcode, string $payload, bool $final)
     {

src/Frame/FrameHandler.php

@@ -30,10 +30,10 @@ class FrameHandler implements LoggerAwareInterface, Stringable
     use OpcodeTrait;
     use StringableTrait;
 
-    private $stream;
-    private $logger;
-    private $pushMasked;
-    private $pullMaskedRequired;
+    private SocketStream $stream;
+    private LoggerInterface $logger;
+    private bool $pushMasked;
+    private bool $pullMaskedRequired;
 
     public function __construct(SocketStream $stream, bool $pushMasked, bool $pullMaskedRequired)
     {

src/Http/HttpHandler.php

@@ -34,9 +34,9 @@ class HttpHandler implements LoggerAwareInterface, Stringable
 {
     use StringableTrait;
 
-    private $stream;
-    private $ssl;
-    private $logger;
+    private SocketStream $stream;
+    private bool $ssl;
+    private LoggerInterface $logger;
 
     public function __construct(SocketStream $stream, bool $ssl = false)
     {

src/Http/Message.php

@@ -24,8 +24,8 @@ abstract class Message implements MessageInterface, Stringable
 {
     use StringableTrait;
 
-    protected $version = '1.1';
-    protected $headers = [];
+    protected string $version = '1.1';
+    protected array $headers = [];
 
     /**
      * Retrieves the HTTP protocol version as a string.

src/Http/Request.php

@@ -20,9 +20,9 @@
  */
 class Request extends Message implements RequestInterface
 {
-    private $target;
-    private $method;
-    private $uri;
+    private string $target = '';
+    private string $method;
+    private Uri $uri;
 
     public function __construct(string $method = 'GET', UriInterface|string|null $uri = null)
     {

src/Http/Response.php

@@ -20,7 +20,7 @@
  */
 class Response extends Message implements ResponseInterface
 {
-    private static $codes = [
+    private static array $codes = [
         100 => 'Continue',
         101 => 'Switching Protocols',
         102 => 'Processing',
@@ -84,8 +84,8 @@ class Response extends Message implements ResponseInterface
         511 => 'Network Authentication Required',
     ];
 
-    private $code;
-    private $reason;
+    private int $code;
+    private string $reason;
 
     public function __construct(int $code = 200, string $reasonPhrase = '')
     {

src/Message/Binary.php

@@ -13,5 +13,5 @@
  */
 class Binary extends Message
 {
-    protected $opcode = 'binary';
+    protected string $opcode = 'binary';
 }

src/Message/Close.php

@@ -13,8 +13,8 @@
  */
 class Close extends Message
 {
-    protected $opcode = 'close';
-    protected $status = null;
+    protected string $opcode = 'close';
+    protected int|null $status = null;
 
     public function __construct(int|null $status = null, string $content = '')
     {

src/Message/Message.php

@@ -21,9 +21,9 @@ abstract class Message implements Stringable
 {
     use StringableTrait;
 
-    protected $opcode;
-    protected $content;
-    protected $timestamp;
+    protected string $opcode;
+    protected string $content;
+    protected DateTimeInterface $timestamp;
 
     public function __construct(string $content = '')
     {

src/Message/MessageHandler.php

@@ -25,11 +25,11 @@ class MessageHandler implements LoggerAwareInterface, Stringable
 {
     use StringableTrait;
 
-    private const DEFAULT_SIZE = 4096;
+    private const int DEFAULT_SIZE = 4096;
 
-    private $frameHandler;
-    private $logger;
-    private $readBuffer;
+    private FrameHandler $frameHandler;
+    private LoggerInterface $logger;
+    private array|null $readBuffer = null;
 
     public function __construct(FrameHandler $frameHandler)
     {

src/Message/Ping.php

@@ -13,5 +13,5 @@
  */
 class Ping extends Message
 {
-    protected $opcode = 'ping';
+    protected string $opcode = 'ping';
 }

src/Message/Pong.php

@@ -13,5 +13,5 @@
  */
 class Pong extends Message
 {
-    protected $opcode = 'pong';
+    protected string $opcode = 'pong';
 }

src/Message/Text.php

@@ -13,5 +13,5 @@
  */
 class Text extends Message
 {
-    protected $opcode = 'text';
+    protected string $opcode = 'text';
 }

src/Middleware/Callback.php

@@ -34,11 +34,11 @@ class Callback implements
     use LoggerAwareTrait;
     use StringableTrait;
 
-    private $incoming;
-    private $outgoing;
-    private $httpIncoming;
-    private $httpOutgoing;
-    private $tick;
+    private Closure|null $incoming;
+    private Closure|null $outgoing;
+    private Closure|null $httpIncoming;
+    private Closure|null $httpOutgoing;
+    private Closure|null $tick;
 
     public function __construct(
         Closure|null $incoming = null,

src/Middleware/FollowRedirect.php

@@ -35,8 +35,8 @@ class FollowRedirect implements LoggerAwareInterface, ProcessHttpIncomingInterfa
     use LoggerAwareTrait;
     use StringableTrait;
 
-    private $limit;
-    private $attempts = 1;
+    private int $limit;
+    private int $attempts = 1;
 
     public function __construct(int $limit = 10)
     {

src/Middleware/MiddlewareHandler.php

@@ -34,16 +34,16 @@ class MiddlewareHandler implements LoggerAwareInterface, Stringable
     use StringableTrait;
 
     // Processor collections
-    private $incoming = [];
-    private $outgoing = [];
-    private $httpIncoming = [];
-    private $httpOutgoing = [];
-    private $tick = [];
+    private array $incoming = [];
+    private array $outgoing = [];
+    private array $httpIncoming = [];
+    private array $httpOutgoing = [];
+    private array $tick = [];
 
     // Handlers
-    private $httpHandler;
-    private $messageHandler;
-    private $logger;
+    private HttpHandler $httpHandler;
+    private MessageHandler $messageHandler;
+    private LoggerInterface $logger;
 
     /**
      * Create MiddlewareHandler.

src/Middleware/PingInterval.php

@@ -28,7 +28,7 @@ class PingInterval implements LoggerAwareInterface, ProcessOutgoingInterface, Pr
     use LoggerAwareTrait;
     use StringableTrait;
 
-    private $interval;
+    private int|null $interval;
 
     public function __construct(int|null $interval = null)
     {

src/Middleware/ProcessHttpStack.php

@@ -23,9 +23,9 @@ class ProcessHttpStack implements Stringable
 {
     use StringableTrait;
 
-    private $connection;
-    private $httpHandler;
-    private $processors;
+    private Connection $connection;
+    private HttpHandler $httpHandler;
+    private array $processors;
 
     /**
      * Create ProcessStack.

src/Middleware/ProcessStack.php

@@ -23,9 +23,9 @@ class ProcessStack implements Stringable
 {
     use StringableTrait;
 
-    private $connection;
-    private $messageHandler;
-    private $processors;
+    private Connection $connection;
+    private MessageHandler $messageHandler;
+    private array $processors;
 
     /**
      * Create ProcessStack.

src/Middleware/ProcessTickStack.php

@@ -19,8 +19,8 @@ class ProcessTickStack implements Stringable
 {
     use StringableTrait;
 
-    private $connection;
-    private $processors;
+    private Connection $connection;
+    private array $processors;
 
     /**
      * Create ProcessStack.

src/Middleware/SubprotocolNegotiation.php

@@ -37,8 +37,8 @@ class SubprotocolNegotiation implements
     use LoggerAwareTrait;
     use StringableTrait;
 
-    private $subprotocols;
-    private $require;
+    private array $subprotocols;
+    private bool $require;
 
     public function __construct(array $subprotocols, bool $require = false)
     {