StreamedClientIo::writeOobData() - Code Metrics - Inspection of "Refactored some methods" - edefimov/async-sockets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 0.4-dev (97f287)

by Evgenij

created 2017-01-15 13:46 UTC

StreamedClientIo::writeOobData() A

↳ Parent: StreamedClientIo

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3.0067

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	10
cts	11
cp	0.9091
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	10
nc	3
nop	2
crap	3.0067

<?php
/**
 * Async sockets
 *
 * @copyright Copyright (c) 2015-2017, Efimov Evgenij <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */
namespace AsyncSockets\Socket\Io;

use AsyncSockets\Exception\DisconnectException;
use AsyncSockets\Exception\NetworkSocketException;
use AsyncSockets\Exception\RecvDataException;
use AsyncSockets\Exception\SendDataException;
use AsyncSockets\Frame\FramePickerInterface;

/**
 * Class StreamedClientIo
 */
class StreamedClientIo extends AbstractClientIo
{
    /**
     * Read attempts count
     */
    const READ_ATTEMPTS = 2;

    /**
     * Amount of read attempts
     *
     * @var int
     */
    private $readAttempts = self::READ_ATTEMPTS;

    /**
     * Remote socket address
     *
     * @var string
     */
    private $remoteAddress;

    /** {@inheritdoc} */
    protected function readRawDataIntoPicker(FramePickerInterface $picker, $isOutOfBand)
    {
        return $isOutOfBand ? $this->readOobData($picker) : $this->readRegularData($picker);
    }

    /** {@inheritdoc} */
    protected function writeRawData($data, $isOutOfBand)
    {
        $resource = $this->socket->getStreamResource();
        $this->verifySendResult('', stream_socket_sendto($resource, ''));

        $written = $isOutOfBand ?
            $this->writeOobData($resource, $data) :
            fwrite($resource, $data, strlen($data));

        $this->verifySendResult($data, $written);

        return $written;
    }

    /**
     * Verifies that send operation completed successfully
     *
     * @param string   $data Data for remote side
     * @param int|bool $sendResult Return value from send function
     *
     * @return void
     * @throws NetworkSocketException
     */
    private function verifySendResult($data, $sendResult)
    {
        if ($sendResult === false || $sendResult < 0) {
            throw new SendDataException(
                $this->socket,
                trim('Failed to send data. ' . $this->getLastPhpErrorMessage())
            );
        }

        if ($sendResult === 0 && !empty($data) && !$this->isConnected()) {
            throw DisconnectException::lostRemoteConnection($this->socket);
        }
    }

    /** {@inheritdoc} */
    protected function isConnected()
    {
        return $this->resolveRemoteAddress() !== null;
    }

    /** {@inheritdoc} */
    protected function getRemoteAddress()
    {
        if ($this->remoteAddress === null) {
            $this->remoteAddress = $this->resolveRemoteAddress();
            if ($this->remoteAddress === null) {
                throw DisconnectException::lostRemoteConnection($this->socket);
            }
        }

        return $this->remoteAddress;
    }

    /** {@inheritdoc} */
    protected function canReachFrame()
    {
        return $this->readAttempts > 0 && $this->isConnected();
    }

    /**
     * Read OOB data from socket
     *
     * @param FramePickerInterface $picker
     *
     * @return string
     */
    private function readOobData(FramePickerInterface $picker)
    {
        $data = stream_socket_recvfrom(
            $this->socket->getStreamResource(),
            self::SOCKET_BUFFER_SIZE,
            STREAM_OOB
        );

        return $picker->pickUpData($data, $this->getRemoteAddress());
    }

    /**
     * Read regular data
     *
     * @param FramePickerInterface $picker Picker to read data into
     *
     * @return string
     */
    private function readRegularData(FramePickerInterface $picker)
    {
        // work-around https://bugs.php.net/bug.php?id=52602
        $resource         = $this->socket->getStreamResource();
        $readContext      = [
            'countCycles'       => 0,
            'dataBeforeIo'      => $this->getDataInSocket(),
            'isStreamDataEmpty' => false,
        ];

        do {
            $data = fread($resource, self::SOCKET_BUFFER_SIZE);
            if ($data === false) {
                throw new RecvDataException(
                    $this->socket,
                    trim('Failed to read data. ' . $this->getLastPhpErrorMessage())
                );
            }

            $isDataEmpty = $data === '';
            $result      = $picker->pickUpData($data, $this->getRemoteAddress());

            $readContext['countCycles']      += 1;
            $readContext['isStreamDataEmpty'] = $this->isReadDataActuallyEmpty($data);
            $this->readAttempts               = $this->resolveReadAttempts($readContext, $this->readAttempts);
        } while (!$picker->isEof() && !$isDataEmpty);

        return $result;
    }

    /**
     * Return first byte from socket buffer
     *
     * @return string
     */
    private function getDataInSocket()
    {
        return stream_socket_recvfrom($this->socket->getStreamResource(), 1, STREAM_PEEK);
    }

    /**
     * Checks whether data read from stream buffer can be filled later
     *
     * @param string $data Read data
     *
     * @return bool
     */
    private function isReadDataActuallyEmpty($data)
    {
        $result = false;
        if ($data === '') {
            $dataInSocket = $this->getDataInSocket();
            $result       = $dataInSocket === '' || $dataInSocket === false;
        }

        return $result;
    }

    /**
     * Calculate attempts value
     *
     * @param array $context Read context
     * @param int   $currentAttempts Current attempts counter
     *
     * @return int
     */
    private function resolveReadAttempts(array $context, $currentAttempts)
    {
        return ($context['countCycles'] === 1 && empty($context['dataBeforeIo'])) ||
               ($context['countCycles'] > 1   && $context['isStreamDataEmpty']) ?
            $currentAttempts - 1 :
            self::READ_ATTEMPTS;

    }

    /**
     * Write out-of-band data
     *
     * @param resource $socket Socket resource
     * @param string   $data Data to write
     *
     * @return int Amount of written bytes
     */
    private function writeOobData($socket, $data)
    {
        $result     = 0;
        $dataLength = strlen($data);
        for ($i = 0; $i < $dataLength; $i++) {
            $written = stream_socket_sendto($socket, $data[$i], STREAM_OOB);
            $this->verifySendResult($data[$i], $written);

            if ($written === 0) {
                break;
            }

            $result += $written;
        }

        return $result;
    }

    /**
     * Return remote address if we connected or false otherwise
     *
     * @return string|null
     */
    private function resolveRemoteAddress()
    {
        $result = stream_socket_get_name($this->socket->getStreamResource(), true);

        return $result !== false ? $result : null;
    }
}


1		<?php
2		/**
3		* Async sockets
4		*
5		* @copyright Copyright (c) 2015-2017, Efimov Evgenij <[email protected]>
6		*
7		* This source file is subject to the MIT license that is bundled
8		* with this source code in the file LICENSE.
9		*/
10		namespace AsyncSockets\Socket\Io;
11
12		use AsyncSockets\Exception\DisconnectException;
13		use AsyncSockets\Exception\NetworkSocketException;
14		use AsyncSockets\Exception\RecvDataException;
15		use AsyncSockets\Exception\SendDataException;
16		use AsyncSockets\Frame\FramePickerInterface;
17
18		/**
19		* Class StreamedClientIo
20		*/
21		class StreamedClientIo extends AbstractClientIo
22		{
23		/**
24		* Read attempts count
25		*/
26		const READ_ATTEMPTS = 2;
27
28		/**
29		* Amount of read attempts
30		*
31		* @var int
32		*/
33		private $readAttempts = self::READ_ATTEMPTS;
34
35		/**
36		* Remote socket address
37		*
38		* @var string
39		*/
40		private $remoteAddress;
41
42		/** {@inheritdoc} */
43	27	protected function readRawDataIntoPicker(FramePickerInterface $picker, $isOutOfBand)
44		{
45	27	return $isOutOfBand ? $this->readOobData($picker) : $this->readRegularData($picker);
46		}
47
48		/** {@inheritdoc} */
49	7	protected function writeRawData($data, $isOutOfBand)
50		{
51	7	$resource = $this->socket->getStreamResource();
52	7	$this->verifySendResult('', stream_socket_sendto($resource, ''));
53
54		$written = $isOutOfBand ?
55	6	$this->writeOobData($resource, $data) :
56	5	fwrite($resource, $data, strlen($data));
57
58	5	$this->verifySendResult($data, $written);
59
60	3	return $written;
61		}
62
63		/**
64		* Verifies that send operation completed successfully
65		*
66		* @param string $data Data for remote side
67		* @param int\|bool $sendResult Return value from send function
68		*
69		* @return void
70		* @throws NetworkSocketException
71		*/
72	7	private function verifySendResult($data, $sendResult)
73		{
74	7	if ($sendResult === false \|\| $sendResult < 0) {
75	3	throw new SendDataException(
76	3	$this->socket,
77	3	trim('Failed to send data. ' . $this->getLastPhpErrorMessage())
78	3	);
79		}
80
81	6	if ($sendResult === 0 && !empty($data) && !$this->isConnected()) {
82	1	throw DisconnectException::lostRemoteConnection($this->socket);
83		}
84	6	}
85
86		/** {@inheritdoc} */
87	40	protected function isConnected()
88		{
89	40	return $this->resolveRemoteAddress() !== null;
90		}
91
92		/** {@inheritdoc} */
93	26	protected function getRemoteAddress()
94		{
95	26	if ($this->remoteAddress === null) {
96	26	$this->remoteAddress = $this->resolveRemoteAddress();
97	26	if ($this->remoteAddress === null) {
98		throw DisconnectException::lostRemoteConnection($this->socket);
99		}
100	26	}
101
102	26	return $this->remoteAddress;
103		}
104
105		/** {@inheritdoc} */
106	3	protected function canReachFrame()
107		{
108	3	return $this->readAttempts > 0 && $this->isConnected();
109		}
110
111		/**
112		* Read OOB data from socket
113		*
114		* @param FramePickerInterface $picker
115		*
116		* @return string
117		*/
118	1	private function readOobData(FramePickerInterface $picker)
119		{
120	1	$data = stream_socket_recvfrom(
121	1	$this->socket->getStreamResource(),
122	1	self::SOCKET_BUFFER_SIZE,
123		STREAM_OOB
124	1	);
125
126	1	return $picker->pickUpData($data, $this->getRemoteAddress());
127		}
128
129		/**
130		* Read regular data
131		*
132		* @param FramePickerInterface $picker Picker to read data into
133		*
134		* @return string
135		*/
136	26	private function readRegularData(FramePickerInterface $picker)
137		{
138		// work-around https://bugs.php.net/bug.php?id=52602
139	26	$resource = $this->socket->getStreamResource();
140		$readContext = [
141	26	'countCycles' => 0,
142	26	'dataBeforeIo' => $this->getDataInSocket(),
143	26	'isStreamDataEmpty' => false,
144	26	];
145
146		do {
147	26	$data = fread($resource, self::SOCKET_BUFFER_SIZE);
148	26	if ($data === false) {
149	1	throw new RecvDataException(
150	1	$this->socket,
151	1	trim('Failed to read data. ' . $this->getLastPhpErrorMessage())
152	1	);
153		}
154
155	25	$isDataEmpty = $data === '';
156	25	$result = $picker->pickUpData($data, $this->getRemoteAddress());
157
158	25	$readContext['countCycles'] += 1;
159	25	$readContext['isStreamDataEmpty'] = $this->isReadDataActuallyEmpty($data);
160	25	$this->readAttempts = $this->resolveReadAttempts($readContext, $this->readAttempts);
161	25	} while (!$picker->isEof() && !$isDataEmpty);
162
163	25	return $result;
164		}
165
166		/**
167		* Return first byte from socket buffer
168		*
169		* @return string
170		*/
171	26	private function getDataInSocket()
172		{
173	26	return stream_socket_recvfrom($this->socket->getStreamResource(), 1, STREAM_PEEK);
174		}
175
176		/**
177		* Checks whether data read from stream buffer can be filled later
178		*
179		* @param string $data Read data
180		*
181		* @return bool
182		*/
183	25	private function isReadDataActuallyEmpty($data)
184		{
185	25	$result = false;
186	25	if ($data === '') {
187	6	$dataInSocket = $this->getDataInSocket();
188	6	$result = $dataInSocket === '' \|\| $dataInSocket === false;
189	6	}
190
191	25	return $result;
192		}
193
194		/**
195		* Calculate attempts value
196		*
197		* @param array $context Read context
198		* @param int $currentAttempts Current attempts counter
199		*
200		* @return int
201		*/
202	25	private function resolveReadAttempts(array $context, $currentAttempts)
203		{
204	25	return ($context['countCycles'] === 1 && empty($context['dataBeforeIo'])) \|\|
205	11	($context['countCycles'] > 1 && $context['isStreamDataEmpty']) ?
206	25	$currentAttempts - 1 :
207	25	self::READ_ATTEMPTS;
208
209		}
210
211		/**
212		* Write out-of-band data
213		*
214		* @param resource $socket Socket resource
215		* @param string $data Data to write
216		*
217		* @return int Amount of written bytes
218		*/
219	2	private function writeOobData($socket, $data)
220		{
221	2	$result = 0;
222	2	$dataLength = strlen($data);
223	2	for ($i = 0; $i < $dataLength; $i++) {
224	2	$written = stream_socket_sendto($socket, $data[$i], STREAM_OOB);
225	2	$this->verifySendResult($data[$i], $written);
226
227	1	if ($written === 0) {
228		break;
229		}
230
231	1	$result += $written;
232	1	}
233
234	1	return $result;
235		}
236
237		/**
238		* Return remote address if we connected or false otherwise
239		*
240		* @return string\|null
241		*/
242	40	private function resolveRemoteAddress()
243		{
244	40	$result = stream_socket_get_name($this->socket->getStreamResource(), true);
245
246	40	return $result !== false ? $result : null;
247		}
248		}
249

edefimov / async-sockets

Branch — 0.4-dev (97f287)

StreamedClientIo::writeOobData() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like