hfw / socket

src/DatagramClient.php

Spacing +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      *
      * @return int
      */
-    final public static function getType (): int {
+    final public static function getType(): int {
         return SOCK_DGRAM;
     }
 

src/ReactiveInterface.php

Spacing +2 added lines, -2 removed lines

@@ -14,13 +14,13 @@
      *
      * @return void
      */
-    public function onOutOfBand (): void;
+    public function onOutOfBand(): void;
 
     /**
      * Called by the reactor when the socket has readable data.
      *
      * @return void
      */
-    public function onReadable (): void;
+    public function onReadable(): void;
 
 }
\ No newline at end of file

src/WebSocket/HandShake.php

Braces +2 added lines, -4 removed lines

@@ -91,8 +91,7 @@ 
                 $value = trim($value);
                 if (isset($this->headers[$key])) {
                     $this->headers[$key] .= ', ' . $value;
-                }
-                else {
+                } else {
                     $this->headers[$key] = $value;
                 }
             }
@@ -101,8 +100,7 @@ 
             $this->upgrade();
             $this->client->write("\r\n\r\n");
             return true;
-        }
-        catch (WebSocketError $e) {
+        } catch (WebSocketError $e) {
             $this->client->write("HTTP/1.1 {$e->getCode()}\r\n\r\n");
             throw $e;
         }

Spacing +9 added lines, -9 removed lines

@@ -48,28 +48,28 @@ 
     /**
      * @param WebSocketClient $client
      */
-    public function __construct (WebSocketClient $client) {
+    public function __construct(WebSocketClient $client) {
         $this->client = $client;
     }
 
     /**
      * @return string[]
      */
-    public function getHeaders () {
+    public function getHeaders() {
         return $this->headers;
     }
 
     /**
      * @return string
      */
-    public function getMethod (): string {
+    public function getMethod(): string {
         return $this->method;
     }
 
     /**
      * @return int
      */
-    public function getRsv (): int {
+    public function getRsv(): int {
         return $this->rsv;
     }
 
@@ -79,7 +79,7 @@ 
      * @return bool
      * @throws WebSocketError
      */
-    public function negotiate (): bool {
+    public function negotiate(): bool {
         $this->buffer .= $this->client->recvAll();
         try {
             if (strlen($this->buffer) > $this->sizeLimit) {
@@ -99,7 +99,7 @@ 
                 $key = strtolower(trim($key));
                 $value = trim($value);
                 if (isset($this->headers[$key])) {
-                    $this->headers[$key] .= ', ' . $value;
+                    $this->headers[$key] .= ', '.$value;
                 }
                 else {
                     $this->headers[$key] = $value;
@@ -120,12 +120,12 @@ 
     /**
      * Sends the connection upgrade headers.
      */
-    protected function upgrade (): void {
+    protected function upgrade(): void {
         $this->client->write(implode("\r\n", [
             "HTTP/1.1 101 Switching Protocols",
             "Connection: Upgrade",
             "Upgrade: websocket",
-            "Sec-WebSocket-Accept: " . base64_encode(sha1($this->headers['sec-websocket-key'] . self::RFC_GUID, true)),
+            "Sec-WebSocket-Accept: ".base64_encode(sha1($this->headers['sec-websocket-key'].self::RFC_GUID, true)),
         ]));
     }
 
@@ -134,7 +134,7 @@ 
      *
      * @throws WebSocketError
      */
-    protected function validate (): void {
+    protected function validate(): void {
         if (!(
             $check = 'method = http 1.1'
             and preg_match('/HTTP\/1\.1$/i', $this->method)

src/WebSocket/WebSocketError.php

Spacing +4 added lines, -4 removed lines

@@ -25,7 +25,7 @@ 
      */
     protected $frame;
 
-    public function __construct (int $code, string $message = '', Frame $frame = null, Throwable $previous = null) {
+    public function __construct(int $code, string $message = '', Frame $frame = null, Throwable $previous = null) {
         parent::__construct($message, $code, $previous);
         $this->frame = $frame;
     }
@@ -33,14 +33,14 @@ 
     /**
      * @return mixed
      */
-    public function getExtra () {
+    public function getExtra() {
         return $this->extra;
     }
 
     /**
      * @return Frame|null
      */
-    public function getFrame () {
+    public function getFrame() {
         return $this->frame;
     }
 
@@ -48,7 +48,7 @@ 
      * @param mixed $extra
      * @return $this
      */
-    public function setExtra ($extra) {
+    public function setExtra($extra) {
         $this->extra = $extra;
         return $this;
     }

src/AbstractClient.php

Spacing +5 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
      *
      * @return string
      */
-    public function __toString () {
+    public function __toString() {
         try {
             return implode(':', $this->getPeerName());
         }
@@ -41,7 +41,7 @@ 
      * @return $this
      * @throws SocketError
      */
-    public function connect (string $address, int $port = 0) {
+    public function connect(string $address, int $port = 0) {
         if (!@socket_connect($this->resource, $address, $port)) {
             // ignore expected errors for non-blocking connections
             $errno = SocketError::getLast($this->resource);
@@ -61,7 +61,7 @@ 
      * @return array `[ 0 => address, 1 => port ]`
      * @throws SocketError
      */
-    public function getPeerName (): array {
+    public function getPeerName(): array {
         if ($this->getDomain() === AF_UNIX) {
             return [$this->getOption(17), 0]; // SO_PEERCRED is not exposed by PHP
         }
@@ -81,7 +81,7 @@ 
      * @return int Total bytes sent.
      * @throws SocketError
      */
-    public function send (string $data, int $flags = 0): int {
+    public function send(string $data, int $flags = 0): int {
         $count = @socket_send($this->resource, $data, strlen($data), $flags);
         if ($count === false) {
             throw new SocketError($this->resource); // reliable errno
@@ -96,7 +96,7 @@ 
      * @return $this
      * @throws SocketError `int` total bytes sent is set as the extra data.
      */
-    public function write (string $data) {
+    public function write(string $data) {
         $length = strlen($data);
         $total = 0;
         while ($total < $length) {

Braces +2 added lines, -4 removed lines

@@ -21,8 +21,7 @@ 
     public function __toString () {
         try {
             return implode(':', $this->getPeerName());
-        }
-        catch (Throwable $e) {
+        } catch (Throwable $e) {
             return "?{$this->resource}";
         }
     }
@@ -102,8 +101,7 @@ 
         while ($total < $length) {
             try {
                 $total += $this->awaitWritable()->send(substr($data, $total));
-            }
-            catch (SocketError $e) {
+            } catch (SocketError $e) {
                 $e->setExtra($total);
                 throw $e;
             }

src/SocketInterface.php

Spacing +3 added lines, -3 removed lines

@@ -27,20 +27,20 @@
      *
      * @return int
      */
-    public function getId (): int;
+    public function getId(): int;
 
     /**
      * Returns the underlying socket resource.
      *
      * @return resource
      */
-    public function getResource ();
+    public function getResource();
 
     /**
      * Whether the underlying resource is usable.
      *
      * @return bool
      */
-    public function isOpen (): bool;
+    public function isOpen(): bool;
 
 }
\ No newline at end of file

src/SocketError.php

Spacing +4 added lines, -4 removed lines

@@ -29,7 +29,7 @@ 
      * @param resource $resource PHP socket resource, or `null` for the global error.
      * @return int If the resource is closed or not a socket, `SOCKET_EBADF` is returned.
      */
-    public static function getLast ($resource = null) {
+    public static function getLast($resource = null) {
         if (isset($resource)) {
             if (@get_resource_type($resource) !== 'Socket') {
                 return SOCKET_EBADF; // Bad file descriptor
@@ -62,7 +62,7 @@ 
      * @param int $fallback Code to assume if one can't be found via the subject.
      * @param SocketError|null $previous Slippage of a prior error.
      */
-    public function __construct ($subject = null, $fallback = 0, SocketError $previous = null) {
+    public function __construct($subject = null, $fallback = 0, SocketError $previous = null) {
         if ($errno = is_int($subject) ? $subject : static::getLast($subject)) {
             $message = socket_strerror($errno);
         }
@@ -77,7 +77,7 @@ 
     /**
      * @return mixed
      */
-    public function getExtra () {
+    public function getExtra() {
         return $this->extra;
     }
 
@@ -85,7 +85,7 @@ 
      * @param mixed $extra
      * @return $this
      */
-    public function setExtra ($extra) {
+    public function setExtra($extra) {
         $this->extra = $extra;
         return $this;
     }

Braces +1 added lines, -2 removed lines

@@ -65,8 +65,7 @@
     public function __construct ($subject = null, $fallback = 0, SocketError $previous = null) {
         if ($errno = is_int($subject) ? $subject : static::getLast($subject)) {
             $message = socket_strerror($errno);
-        }
-        else {
+        } else {
             $errno = $fallback;
             $last = error_get_last();
             $message = "{$last['message']} in {$last['file']}:{$last['line']}";

src/AbstractSocket.php

Braces +2 added lines, -4 removed lines

@@ -52,11 +52,9 @@
     public function __construct ($resource) {
         if (!is_resource($resource) or get_resource_type($resource) !== 'Socket') {
             throw new InvalidArgumentException('Expected an open socket resource.', SOCKET_EBADF);
-        }
-        elseif (socket_get_option($resource, SOL_SOCKET, SO_TYPE) !== static::getType()) {
+        } elseif (socket_get_option($resource, SOL_SOCKET, SO_TYPE) !== static::getType()) {
             throw new InvalidArgumentException('Invalid socket type for ' . static::class, SOCKET_ESOCKTNOSUPPORT);
-        }
-        elseif ($errno = SocketError::getLast($resource)) {
+        } elseif ($errno = SocketError::getLast($resource)) {
             // "File descriptor in bad state"
             throw new SocketError(SOCKET_EBADFD, 0, new SocketError($errno));
         }

Doc Comments +2 added lines, -2 removed lines

@@ -151,7 +151,7 @@ 
      * @see https://php.net/socket_get_option
      *
      * @param int $option `SO_*` option constant.
-     * @return mixed The option's value. This is never `false`.
+     * @return integer The option's value. This is never `false`.
      * @throws SocketError
      */
     public function getOption (int $option) {
@@ -213,7 +213,7 @@ 
      * @see await()
      *
      * @param int $channel `SocketInterface` channel constant.
-     * @param float|null $timeout Maximum seconds to block. `NULL` blocks forever. Defaults to a poll.
+     * @param integer $timeout Maximum seconds to block. `NULL` blocks forever. Defaults to a poll.
      * @return bool
      * @throws SocketError
      */

Spacing +29 added lines, -29 removed lines

@@ -14,7 +14,7 @@ 
      *
      * @return int
      */
-    abstract public static function getType (): int;
+    abstract public static function getType(): int;
 
     /**
      * The underlying PHP resource.
@@ -33,7 +33,7 @@ 
      * @return static
      * @throws SocketError
      */
-    public static function create (int $domain = AF_INET, ...$extra) {
+    public static function create(int $domain = AF_INET, ...$extra) {
         if (!$resource = @socket_create($domain, static::getType(), 0)) { // auto-protocol
             throw new SocketError; // reliable errno
         }
@@ -49,12 +49,12 @@ 
      * @throws InvalidArgumentException Not a socket resource, or the socket is of the wrong type.
      * @throws SocketError Slippage of an existing error on the resource.
      */
-    public function __construct ($resource) {
+    public function __construct($resource) {
         if (!is_resource($resource) or get_resource_type($resource) !== 'Socket') {
             throw new InvalidArgumentException('Expected an open socket resource.', SOCKET_EBADF);
         }
         elseif (socket_get_option($resource, SOL_SOCKET, SO_TYPE) !== static::getType()) {
-            throw new InvalidArgumentException('Invalid socket type for ' . static::class, SOCKET_ESOCKTNOSUPPORT);
+            throw new InvalidArgumentException('Invalid socket type for '.static::class, SOCKET_ESOCKTNOSUPPORT);
         }
         elseif ($errno = SocketError::getLast($resource)) {
             // "File descriptor in bad state"
@@ -68,7 +68,7 @@ 
      *
      * @see close()
      */
-    public function __destruct () {
+    public function __destruct() {
         if ($this->isOpen()) {
             $this->close();
         }
@@ -85,7 +85,7 @@ 
      * @return $this
      * @throws SocketError
      */
-    public function await (int $channel) {
+    public function await(int $channel) {
         $rwe = [$channel => [$this->resource]];
         if (!@socket_select($rwe[0], $rwe[1], $rwe[2], null)) {
             throw new SocketError($this->resource);
@@ -98,7 +98,7 @@ 
      *
      * @return $this
      */
-    final public function awaitOutOfBand () {
+    final public function awaitOutOfBand() {
         return $this->await(self::CH_EXCEPT);
     }
 
@@ -107,7 +107,7 @@ 
      *
      * @return $this
      */
-    final public function awaitReadable () {
+    final public function awaitReadable() {
         return $this->await(self::CH_READ);
     }
 
@@ -116,7 +116,7 @@ 
      *
      * @return $this
      */
-    final public function awaitWritable () {
+    final public function awaitWritable() {
         return $this->await(self::CH_WRITE);
     }
 
@@ -129,7 +129,7 @@ 
      *
      * @return $this
      */
-    public function close () {
+    public function close() {
         socket_close($this->resource);
         return $this;
     }
@@ -139,15 +139,15 @@ 
      *
      * @return int
      */
-    final public function getDomain (): int {
+    final public function getDomain(): int {
         return $this->getOption(39); // SO_DOMAIN is not exposed by PHP
     }
 
     /**
      * @return int
      */
-    final public function getId (): int {
-        return (int)$this->resource;
+    final public function getId(): int {
+        return (int) $this->resource;
     }
 
     /**
@@ -159,7 +159,7 @@ 
      * @return mixed The option's value. This is never `false`.
      * @throws SocketError
      */
-    public function getOption (int $option) {
+    public function getOption(int $option) {
         $value = @socket_get_option($this->resource, SOL_SOCKET, $option);
         if ($value === false) {
             throw new SocketError($this->resource, SOCKET_EINVAL);
@@ -170,7 +170,7 @@ 
     /**
      * @return resource
      */
-    final public function getResource () {
+    final public function getResource() {
         return $this->resource;
     }
 
@@ -182,7 +182,7 @@ 
      * @return array `[ 0 => address, 1 => port ]`
      * @throws SocketError
      */
-    public function getSockName (): array {
+    public function getSockName(): array {
         if (!@socket_getsockname($this->resource, $addr, $port)) {
             throw new SocketError($this->resource, SOCKET_EOPNOTSUPP);
         }
@@ -192,7 +192,7 @@ 
     /**
      * @return bool
      */
-    public function isOpen (): bool {
+    public function isOpen(): bool {
         return is_resource($this->resource);
     }
 
@@ -203,7 +203,7 @@ 
      *
      * @return bool
      */
-    final public function isOutOfBand (): bool {
+    final public function isOutOfBand(): bool {
         return $this->isReady(self::CH_EXCEPT);
     }
 
@@ -214,7 +214,7 @@ 
      *
      * @return bool
      */
-    final public function isReadable (): bool {
+    final public function isReadable(): bool {
         return $this->isReady(self::CH_READ);
     }
 
@@ -228,15 +228,15 @@ 
      * @return bool
      * @throws SocketError
      */
-    public function isReady (int $channel, ?float $timeout = 0): bool {
+    public function isReady(int $channel, ?float $timeout = 0): bool {
         $rwe = [$channel => [$this->resource]];
         // core casts non-null timeout to int.
         // usec is ignored if timeout is null.
-        $usec = (int)(fmod($timeout, 1) * 1000000);
+        $usec = (int) (fmod($timeout, 1) * 1000000);
         if (false === $count = @socket_select($rwe[0], $rwe[1], $rwe[2], $timeout, $usec)) {
             throw new SocketError($this->resource);
         }
-        return (bool)$count;
+        return (bool) $count;
     }
 
     /**
@@ -246,7 +246,7 @@ 
      *
      * @return bool
      */
-    final public function isWritable (): bool {
+    final public function isWritable(): bool {
         return $this->isReady(self::CH_WRITE);
     }
 
@@ -270,7 +270,7 @@ 
      * @return $this
      * @throws SocketError
      */
-    public function setBlocking (bool $blocking) {
+    public function setBlocking(bool $blocking) {
         if ($blocking ? @socket_set_block($this->resource) : @socket_set_nonblock($this->resource)) {
             return $this;
         }
@@ -287,7 +287,7 @@ 
      * @return $this
      * @throws SocketError
      */
-    public function setOption (int $option, $value) {
+    public function setOption(int $option, $value) {
         if (!@socket_set_option($this->resource, SOL_SOCKET, $option, $value)) {
             throw new SocketError($this->resource, SOCKET_EINVAL);
         }
@@ -300,10 +300,10 @@ 
      * @param float $timeout Zero means "no timeout" (block forever).
      * @return $this
      */
-    public function setTimeout (float $timeout) {
+    public function setTimeout(float $timeout) {
         $tv = [
-            'sec' => (int)$timeout,
-            'usec' => (int)(fmod($timeout, 1) * 1000000)
+            'sec' => (int) $timeout,
+            'usec' => (int) (fmod($timeout, 1) * 1000000)
         ];
         $this->setOption(SO_RCVTIMEO, $tv);
         $this->setOption(SO_SNDTIMEO, $tv);
@@ -333,7 +333,7 @@ 
      * @return $this
      * @throws SocketError
      */
-    public function shutdown (int $channel) {
+    public function shutdown(int $channel) {
         if (!@socket_shutdown($this->resource, $channel)) {
             throw new SocketError($this->resource); // reliable errno
         }

src/WebSocket/FrameReader.php

Braces +3 added lines, -6 removed lines

@@ -67,11 +67,9 @@ 
                 ];
                 $this->buffer = substr($this->buffer, strlen($head[0]));
                 $this->validate();
-            }
-            elseif (strlen($this->buffer) >= 14) { // max head room
+            } elseif (strlen($this->buffer) >= 14) { // max head room
                 throw new WebSocketError(Frame::CLOSE_PROTOCOL_ERROR, 'Bad frame.');
-            }
-            else {
+            } else {
                 return null;
             }
         }
@@ -139,8 +137,7 @@ 
             if (!$this->head['final']) {
                 throw new WebSocketError(Frame::CLOSE_PROTOCOL_ERROR, "Received fragmented {$name}");
             }
-        }
-        elseif ($opCode > Frame::OP_BINARY) { // data
+        } elseif ($opCode > Frame::OP_BINARY) { // data
             throw new WebSocketError(Frame::CLOSE_PROTOCOL_ERROR, "Received {$name}");
         }
     }

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
     /**
      * Yields all available frames from the peer.
      *
-     * @return Generator|Frame[]
+     * @return Generator
      */
     public function getFrames () {
         $this->buffer .= $this->client->recvAll();

Spacing +6 added lines, -6 removed lines

@@ -49,7 +49,7 @@ 
      */
     protected $maxLength = 10 * 1024 * 1024;
 
-    public function __construct (WebSocketClient $client) {
+    public function __construct(WebSocketClient $client) {
         $this->client = $client;
     }
 
@@ -57,7 +57,7 @@ 
      * @return null|Frame
      * @throws WebSocketError
      */
-    protected function getFrame (): ?Frame {
+    protected function getFrame(): ?Frame {
         if (!$this->head) {
             if (preg_match(self::REGEXP, $this->buffer, $head)) {
                 [, $op, $len] = unpack('C2', $head[0]);
@@ -99,7 +99,7 @@ 
      *
      * @return Generator|Frame[]
      */
-    public function getFrames () {
+    public function getFrames() {
         $this->buffer .= $this->client->recvAll();
         while ($frame = $this->getFrame()) {
             yield $frame;
@@ -109,7 +109,7 @@ 
     /**
      * @return int
      */
-    public function getMaxLength (): int {
+    public function getMaxLength(): int {
         return $this->maxLength;
     }
 
@@ -117,7 +117,7 @@ 
      * @param int $bytes
      * @return $this
      */
-    public function setMaxLength (int $bytes) {
+    public function setMaxLength(int $bytes) {
         if ($bytes < self::MAX_LENGTH_RANGE[0] or $bytes > self::MAX_LENGTH_RANGE[1]) {
             throw new InvalidArgumentException('Max length must be within range [125,2^63-1]');
         }
@@ -130,7 +130,7 @@ 
      *
      * @throws WebSocketError
      */
-    protected function validate (): void {
+    protected function validate(): void {
         if ($this->head['length'] > $this->maxLength) {
             throw new WebSocketError(Frame::CLOSE_TOO_LARGE, "Payload would exceed {$this->maxLength} bytes");
         }