Pheanstalk\Socket\SocketSocket

Complexity

Total Complexity

19

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Test Coverage

Coverage

83.87%

Importance

Changes	4
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	checkClosed()	0	4	2
A	throwException()	0	4	1
A	getLine()	0	17	3
A	read()	0	14	3
A	write()	0	9	3
A	disconnect()	0	5	1
B	__construct()	0	39	6

<?php


namespace Pheanstalk\Socket;

use Pheanstalk\Contract\SocketInterface;
use Pheanstalk\Exception\ConnectionException;
use Pheanstalk\Exception\SocketException;

/**
 * A Socket implementation using the Sockets extension
 */
class SocketSocket implements SocketInterface
{
    /** @var resource */
    private $socket;

    public function __construct(
        string $host,
        int $port,
        float $connectTimeout
    ) {
        if (!extension_loaded('sockets')) {
            throw new \Exception('Sockets extension not found');
        }

        $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);

It seems like socket_create(Pheanstalk\Socket\AF_INET, Pheanstalk\Socket\SOCK_STREAM, Pheanstalk\Socket\SOL_TCP) can also be of type Socket. However, the property $socket is declared as type resource. Maybe add an additional type check?

        if ($this->socket === false) {
            $this->throwException();
        }

        $timeout = [
            'sec' => intval($connectTimeout),
            'usec' => ($connectTimeout - intval($connectTimeout)) * 1000000
        ];

        $sendTimeout = socket_get_option($this->socket, SOL_SOCKET, SO_SNDTIMEO);
        $receiveTimeout = socket_get_option($this->socket, SOL_SOCKET, SO_RCVTIMEO);
        socket_set_option($this->socket, SOL_SOCKET, SO_KEEPALIVE, 1);
        socket_set_option($this->socket, SOL_SOCKET, SO_SNDTIMEO, $timeout);
        socket_set_option($this->socket, SOL_SOCKET, SO_RCVTIMEO, $timeout);
        if (socket_set_block($this->socket) === false) {
            throw new ConnectionException(0, "Failed to set socket to blocking mode");
        }

        $addresses = gethostbynamel($host);
        if ($addresses === false) {
            throw new ConnectionException(0, "Could not resolve hostname $host");
        }
        if (@socket_connect($this->socket, $addresses[0], $port) === false) {
            $error = socket_last_error($this->socket);
            throw new ConnectionException($error, socket_strerror($error));
        };

        socket_set_option($this->socket, SOL_SOCKET, SO_SNDTIMEO, $sendTimeout);
        socket_set_option($this->socket, SOL_SOCKET, SO_RCVTIMEO, $receiveTimeout);
    }

    /**
     * Writes data to the socket.
     *
     * @param string $data
     *
     * @return void
     */
    public function write(string $data): void
    {
        $this->checkClosed();
        while (!empty($data)) {
            $written = socket_write($this->socket, $data);
            if ($written === false) {
                $this->throwException();
            }
            $data = substr($data, $written);
        }
    }

    private function throwException()
    {
        $error = socket_last_error($this->socket);
        throw new SocketException(socket_strerror($error), $error);
    }

    private function checkClosed()
    {
        if (!isset($this->socket)) {
            throw new SocketException('The connection was closed');
        }
    }

    /**
     * Reads up to $length bytes from the socket.
     *
     * @return string
     */
    public function read(int $length): string
    {
        $this->checkClosed();

        $buffer = '';
        while (mb_strlen($buffer, '8BIT') < $length) {
            $result = socket_read($this->socket, $length - mb_strlen($buffer, '8BIT'));
            if ($result === false) {
                $this->throwException();
            }
            $buffer .= $result;
        }

        return $buffer;
    }

    public function getLine(): string
    {
        $this->checkClosed();

        $buffer = '';
        // Reading stops at \r or \n. In case it stopped at \r we must continue reading.
        while (substr($buffer, -1, 1) !== "\n") {
            $result = socket_read($this->socket, 1024, PHP_NORMAL_READ);
            if ($result === false) {
                $this->throwException();
            }
            $buffer .= $result;
        }



        return rtrim($buffer);
    }

    /**
     * Disconnect the socket; subsequent usage of the socket will fail.
     */
    public function disconnect(): void
    {
        $this->checkClosed();
        socket_close($this->socket);
        unset($this->socket);
    }
}