hfw / socket

src/AbstractSocket.php

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);
     }
 
@@ -127,7 +127,7 @@ 
      *
      * @return $this
      */
-    public function close () {
+    public function close() {
         socket_close($this->resource); // never errors
         return $this;
     }
@@ -137,12 +137,12 @@ 
      *
      * @return int
      */
-    final public function getDomain (): int {
+    final public function getDomain(): int {
         return $this->getOption(39); // SO_DOMAIN is not exposed by PHP
     }
 
-    final public function getId (): int {
-        return (int)$this->resource;
+    final public function getId(): int {
+        return (int) $this->resource;
     }
 
     /**
@@ -154,7 +154,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);
@@ -162,7 +162,7 @@ 
         return $value;
     }
 
-    final public function getResource () {
+    final public function getResource() {
         return $this->resource;
     }
 
@@ -174,14 +174,14 @@ 
      * @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);
         }
         return [$addr, $port];
     }
 
-    public function isOpen (): bool {
+    public function isOpen(): bool {
         return is_resource($this->resource);
     }
 
@@ -192,7 +192,7 @@ 
      *
      * @return bool
      */
-    final public function isOutOfBand (): bool {
+    final public function isOutOfBand(): bool {
         return $this->isReady(self::CH_EXCEPT);
     }
 
@@ -203,7 +203,7 @@ 
      *
      * @return bool
      */
-    final public function isReadable (): bool {
+    final public function isReadable(): bool {
         return $this->isReady(self::CH_READ);
     }
 
@@ -217,15 +217,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;
     }
 
     /**
@@ -235,7 +235,7 @@ 
      *
      * @return bool
      */
-    final public function isWritable (): bool {
+    final public function isWritable(): bool {
         return $this->isReady(self::CH_WRITE);
     }
 
@@ -257,7 +257,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;
         }
@@ -274,7 +274,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);
         }
@@ -287,10 +287,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);
@@ -320,7 +320,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/StreamClient.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      * @see https://php.net/socket_create_pair
      *
      * @param array $extra Variadic constructor arguments.
-     * @return static[] Two instances at indices `0` and `1`.
+     * @return StreamClient[] Two instances at indices `0` and `1`.
      * @throws SocketError
      */
     public static function newUnixPair (...$extra) {

Spacing +6 added lines, -6 removed lines

@@ -12,7 +12,7 @@ 
      *
      * @return int
      */
-    final public static function getType (): int {
+    final public static function getType(): int {
         return SOCK_STREAM;
     }
 
@@ -25,7 +25,7 @@ 
      * @return static[] Two instances at indices `0` and `1`.
      * @throws SocketError
      */
-    public static function newUnixPair (...$extra) {
+    public static function newUnixPair(...$extra) {
         if (!@socket_create_pair(AF_UNIX, SOCK_STREAM, 0, $fd)) {
             throw new SocketError; // reliable errno
         }
@@ -44,7 +44,7 @@ 
      * @return string
      * @throws SocketError The partially read data is attached.
      */
-    public function read (int $length): string {
+    public function read(int $length): string {
         try {
             $data = '';
             do {
@@ -71,11 +71,11 @@ 
      * @return string
      * @throws SocketError
      */
-    public function recv (int $maxLength, int $flags = 0): string {
+    public function recv(int $maxLength, int $flags = 0): string {
         if (false === @socket_recv($this->resource, $data, $maxLength, $flags)) {
             throw new SocketError($this->resource, SOCKET_EINVAL);
         }
-        return (string)$data; // cast needed, will be null if 0 bytes are read.
+        return (string) $data; // cast needed, will be null if 0 bytes are read.
     }
 
     /**
@@ -85,7 +85,7 @@ 
      * @return string
      * @throws SocketError
      */
-    public function recvAll (int $flags = 0): string {
+    public function recvAll(int $flags = 0): string {
         $flags = ($flags & ~MSG_WAITALL) | MSG_DONTWAIT;
         $length = $this->getOption(SO_RCVBUF);
         try {

src/WebSocket/WebSocketServer.php

Spacing +13 added lines, -13 removed lines

@@ -29,7 +29,7 @@ 
      * @param $resource
      * @param Reactor $reactor
      */
-    public function __construct ($resource, Reactor $reactor) {
+    public function __construct($resource, Reactor $reactor) {
         parent::__construct($resource);
         $reactor->add($this);
         $this->reactor = $reactor;
@@ -38,7 +38,7 @@ 
     /**
      * @return WebSocketClient
      */
-    public function accept () {
+    public function accept() {
         /** @var WebSocketClient $client */
         $client = parent::accept();
         $this->clients[$client->getId()] = $client;
@@ -52,7 +52,7 @@ 
      * @param int $opCode
      * @param string $payload
      */
-    public function broadcast (int $opCode, string $payload) {
+    public function broadcast(int $opCode, string $payload) {
         foreach ($this->clients as $client) {
             if ($client->isOk()) {
                 $client->getFrameHandler()->write($opCode, $payload);
@@ -63,7 +63,7 @@ 
     /**
      * @param string $payload
      */
-    public function broadcastBinary (string $payload) {
+    public function broadcastBinary(string $payload) {
         $this->broadcast(Frame::OP_BINARY, $payload);
     }
 
@@ -72,7 +72,7 @@ 
      *
      * @param string $payload
      */
-    public function broadcastPing (string $payload = '') {
+    public function broadcastPing(string $payload = '') {
         $this->broadcast(Frame::OP_PING, $payload);
     }
 
@@ -81,7 +81,7 @@ 
      *
      * @param string $text
      */
-    public function broadcastText (string $text) {
+    public function broadcastText(string $text) {
         $this->broadcast(Frame::OP_TEXT, $text);
     }
 
@@ -92,7 +92,7 @@ 
      * @param string $reason
      * @return StreamServer
      */
-    public function close (int $code = Frame::CLOSE_INTERRUPT, $reason = '') {
+    public function close(int $code = Frame::CLOSE_INTERRUPT, $reason = '') {
         foreach ($this->clients as $client) {
             try {
                 $client->close($code, $reason);
@@ -110,14 +110,14 @@ 
      *
      * @return int
      */
-    public function count (): int {
+    public function count(): int {
         return count($this->clients);
     }
 
     /**
      * @return WebSocketClient[]
      */
-    public function getClients () {
+    public function getClients() {
         return $this->clients;
     }
 
@@ -125,17 +125,17 @@ 
      * @param resource $resource
      * @return WebSocketClient
      */
-    protected function newClient ($resource) {
+    protected function newClient($resource) {
         return new WebSocketClient($resource, $this);
     }
 
     /**
      * Servers never get OOB data.
      */
-    final public function onOutOfBand (): void {
+    final public function onOutOfBand(): void {
     }
 
-    public function onReadable (): void {
+    public function onReadable(): void {
         $this->accept();
     }
 
@@ -144,7 +144,7 @@ 
      *
      * @param WebSocketClient $client
      */
-    public function remove (WebSocketClient $client) {
+    public function remove(WebSocketClient $client) {
         unset($this->clients[$client->getId()]);
         $this->reactor->remove($client);
     }

src/WebSocket/FrameHandler.php

Spacing +26 added lines, -26 removed lines

@@ -46,21 +46,21 @@ 
      */
     protected $maxLength = 10 * 1024 * 1024;
 
-    public function __construct (WebSocketClient $client) {
+    public function __construct(WebSocketClient $client) {
         $this->client = $client;
     }
 
     /**
      * @return int
      */
-    public function getFragmentSize (): int {
+    public function getFragmentSize(): int {
         return $this->fragmentSize;
     }
 
     /**
      * @return int
      */
-    public function getMaxLength (): int {
+    public function getMaxLength(): int {
         return $this->maxLength;
     }
 
@@ -72,7 +72,7 @@ 
      * @param Frame $binary
      * @throws WebSocketError
      */
-    protected function onBinary (Frame $binary): void {
+    protected function onBinary(Frame $binary): void {
         $this->buffer .= $binary->getPayload();
         if ($binary->isFinal()) {
             $message = $this->buffer;
@@ -92,7 +92,7 @@ 
      *
      * @param Frame $close
      */
-    protected function onClose (Frame $close): void {
+    protected function onClose(Frame $close): void {
         $this->client->close($close->getCloseCode());
     }
 
@@ -102,7 +102,7 @@ 
      * @param Frame $frame
      * @throws WebSocketError
      */
-    protected function onContinue (Frame $frame): void {
+    protected function onContinue(Frame $frame): void {
         try {
             switch ($this->continue) {
                 case Frame::OP_TEXT:
@@ -135,7 +135,7 @@ 
      *
      * @param Frame $control
      */
-    protected function onControl (Frame $control): void {
+    protected function onControl(Frame $control): void {
         if ($control->isClose()) {
             $this->onClose($control);
         }
@@ -152,7 +152,7 @@ 
      *
      * @param Frame $data
      */
-    protected function onData (Frame $data): void {
+    protected function onData(Frame $data): void {
         $this->onData_SetContinue($data);
         if ($data->isText()) {
             $this->onText($data);
@@ -162,7 +162,7 @@ 
         }
     }
 
-    protected function onData_SetContinue (Frame $data): void {
+    protected function onData_SetContinue(Frame $data): void {
         if ($this->continue) {
             $existing = Frame::NAMES[$this->continue];
             throw new WebSocketError(
@@ -183,7 +183,7 @@ 
      *
      * @param Frame $frame
      */
-    public function onFrame (Frame $frame): void {
+    public function onFrame(Frame $frame): void {
         $this->onFrame_CheckRsv($frame);
         $this->onFrame_CheckLength($frame);
         if ($frame->isControl()) {
@@ -200,7 +200,7 @@ 
     /**
      * @param Frame $frame
      */
-    protected function onFrame_CheckLength (Frame $frame): void {
+    protected function onFrame_CheckLength(Frame $frame): void {
         if ($frame->isData()) {
             $length = strlen($this->buffer);
             if ($length + $frame->getLength() > $this->maxLength) {
@@ -219,7 +219,7 @@ 
      * @param Frame $frame
      * @throws WebSocketError
      */
-    protected function onFrame_CheckRsv (Frame $frame): void {
+    protected function onFrame_CheckRsv(Frame $frame): void {
         if ($badRsv = $frame->getRsv() & ~$this->client->getHandshake()->getRsv()) {
             $badRsv = str_pad(base_convert($badRsv >> 4, 10, 2), 3, '0', STR_PAD_LEFT);
             throw new WebSocketError(Frame::CLOSE_PROTOCOL_ERROR, "Received unknown RSV bits: 0b{$badRsv}");
@@ -233,7 +233,7 @@ 
      *
      * @param Frame $ping
      */
-    protected function onPing (Frame $ping): void {
+    protected function onPing(Frame $ping): void {
         $this->writePong($ping->getPayload());
     }
 
@@ -244,7 +244,7 @@ 
      *
      * @param Frame $pong
      */
-    protected function onPong (Frame $pong): void {
+    protected function onPong(Frame $pong): void {
         // stub
     }
 
@@ -256,7 +256,7 @@ 
      * @param Frame $text
      * @throws WebSocketError
      */
-    protected function onText (Frame $text): void {
+    protected function onText(Frame $text): void {
         $this->buffer .= $text->getPayload();
         if ($text->isFinal()) {
             $message = $this->buffer;
@@ -269,7 +269,7 @@ 
      * @param int $bytes
      * @return $this
      */
-    public function setFragmentSize (int $bytes) {
+    public function setFragmentSize(int $bytes) {
         $this->fragmentSize = $bytes;
         return $this;
     }
@@ -278,7 +278,7 @@ 
      * @param int $bytes
      * @return $this
      */
-    public function setMaxLength (int $bytes) {
+    public function setMaxLength(int $bytes) {
         $this->maxLength = $bytes;
         return $this;
     }
@@ -289,7 +289,7 @@ 
      * @param int $opCode
      * @param string $payload
      */
-    public function write (int $opCode, string $payload): void {
+    public function write(int $opCode, string $payload): void {
         $offset = 0;
         $total = strlen($payload);
         do {
@@ -305,7 +305,7 @@ 
     /**
      * @param string $payload
      */
-    public function writeBinary (string $payload): void {
+    public function writeBinary(string $payload): void {
         $this->write(Frame::OP_BINARY, $payload);
     }
 
@@ -313,8 +313,8 @@ 
      * @param int $code
      * @param string $reason
      */
-    public function writeClose (int $code = Frame::CLOSE_NORMAL, string $reason = ''): void {
-        $this->writeFrame(true, Frame::OP_CLOSE, pack('n', $code) . $reason);
+    public function writeClose(int $code = Frame::CLOSE_NORMAL, string $reason = ''): void {
+        $this->writeFrame(true, Frame::OP_CLOSE, pack('n', $code).$reason);
     }
 
     /**
@@ -324,7 +324,7 @@ 
      * @param int $opCode
      * @param string $payload
      */
-    protected function writeFrame (bool $final, int $opCode, string $payload): void {
+    protected function writeFrame(bool $final, int $opCode, string $payload): void {
         if ($opCode & 0x08 and !$final) {
             throw new WebSocketError(
                 Frame::CLOSE_INTERNAL_ERROR,
@@ -344,27 +344,27 @@ 
         else {
             $head .= chr($length);
         }
-        $this->client->write($head . $payload);
+        $this->client->write($head.$payload);
     }
 
     /**
      * @param string $payload
      */
-    public function writePing (string $payload = ''): void {
+    public function writePing(string $payload = ''): void {
         $this->writeFrame(true, Frame::OP_PING, $payload);
     }
 
     /**
      * @param string $payload
      */
-    public function writePong (string $payload = ''): void {
+    public function writePong(string $payload = ''): void {
         $this->writeFrame(true, Frame::OP_PONG, $payload);
     }
 
     /**
      * @param string $payload
      */
-    public function writeText (string $payload): void {
+    public function writeText(string $payload): void {
         $this->write(Frame::OP_TEXT, $payload);
     }
 }
\ No newline at end of file