Helix\Socket\StreamClient

Complexity

Total Complexity

10

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Importance

Changes	18
Bugs	1	Features	3

4 Methods

Rating	Name	Duplication	Size	Complexity
A	read()	0	16	4
A	getType()	0	2	1
A	newUnixPair()	0	7	2
A	recv()	0	10	3

<?php

namespace Helix\Socket;

/**
 * Full duplex connection.
 */
class StreamClient extends AbstractClient {

    /**
     * **Variadic.**
     * Creates a pair of interconnected Unix instances that can be used for IPC.
     *
     * @link https://php.net/socket_create_pair
     *
     * @param array $extra Variadic constructor arguments.
     * @return static[] Two instances at indices `0` and `1`.
     * @throws Error
     */
    public static function newUnixPair (...$extra) {
        if (!@socket_create_pair(AF_UNIX, SOCK_STREAM, 0, $fd)) {
            throw new Error; // reliable errno
        }
        return [
            new static(...array_merge([$fd[0]], $extra)),

array_merge(array($fd[0]), $extra) is expanded, but the parameter $resource of Helix\Socket\StreamClient::__construct() does not expect variable arguments.

            new static(...array_merge([$fd[1]], $extra))
        ];
    }

    /**
     * `SOCK_STREAM`
     *
     * @return int
     */
    final public static function getType () {
        return SOCK_STREAM;
    }

    /**
     * Reads the specified length in a blocking manner.
     * May return less than the desired length if the peer shut down writing.
     *
     * @see onTimeout()
     *
     * @param int $length
     * @return string
     * @throws Error The error's extra data is set to what was partially read.
     */
    public function read ($length) {
        $data = '';
        while ($length > 0) {
            try {
                $data .= $chunk = $this->await(self::CH_READ)->recv($length);
                $length -= strlen($chunk);
                if ($chunk === '') {
                    return $data;
                }
            }
            catch (Error $error) {
                $error->setExtra($data);
                throw $error;
            }
        }
        return $data;
    }

    /**
     * Receives data from the peer.
     *
     * @link https://php.net/socket_recv
     *
     * @see onTimeout()
     *
     * @param int $length Maximum amount of bytes to receive.
     * @param int $flags `MSG_*`
     * @throws Error
     * @return string
     */
    public function recv ($length, $flags = 0) {
        $count = @socket_recv($this->resource, $data, $length, $flags);
        if ($count === false) {
            $error = new Error($this->resource, SOCKET_EINVAL);
            if ($error->getCode() === SOCKET_ETIMEDOUT) {
                $this->onTimeout();
            }
            throw $error;
        }
        return (string)$data; // cast needed, will be null if 0 bytes are read.
    }

}