AbstractClientIo::write() - Code Metrics - Inspection of "OOB data reading" - edefimov/async-sockets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 0.4-dev (d01bc8)

by Evgenij

created 2016-04-29 19:48 UTC

AbstractClientIo::write() A

↳ Parent: AbstractClientIo

Complexity

Conditions	3
Paths	2

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3

Importance

Changes	8
Bugs	0	Features	0

Metric	Value
c	8
b	0
f	0
dl	0
loc	15
ccs	10
cts	10
cp	1
rs	9.4285
cc	3
eloc	9
nc	2
nop	3
crap	3

<?php
/**
 * Async sockets
 *
 * @copyright Copyright (c) 2015-2016, 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\ConnectionException;
use AsyncSockets\Exception\FrameException;
use AsyncSockets\Exception\NetworkSocketException;
use AsyncSockets\Exception\UnsupportedOperationException;
use AsyncSockets\Frame\FramePickerInterface;
use AsyncSockets\Frame\PartialFrame;
use AsyncSockets\Socket\SocketInterface;

/**
 * Class AbstractClientIo
 */
abstract class AbstractClientIo extends AbstractIo
{
    /**
     * Disconnected state
     */
    const STATE_DISCONNECTED = 0;

    /**
     * Connected state
     */
    const STATE_CONNECTED = 1;

    /**
     * Socket state
     *
     * @var int
     */
    private $state = self::STATE_DISCONNECTED;

    /**
     * Amount of attempts to write data before treat request as failed
     *
     * @var int
     */
    private $writeAttempts = self::IO_ATTEMPTS;

    /**
     * Maximum amount of OOB data length (0 - not supported)
     *
     * @var int
     */
    private $maxOobPacketLength;

    /**
     * AbstractClientIo constructor.
     *
     * @param SocketInterface $socket Socket object
     * @param int             $maxOobPacketLength Maximum amount of OOB data length (0 - not supported)
     */
    public function __construct(SocketInterface $socket, $maxOobPacketLength)
    {
        parent::__construct($socket);
        $this->maxOobPacketLength = $maxOobPacketLength;
    }

    /**
     * Read raw data from network into given picker
     *
     * @param FramePickerInterface $picker Frame picker
     * @param bool                 $isOutOfBand Flag if these are out of band data
     *
     * @return string Data after end of frame
     */
    abstract protected function readRawDataIntoPicker(FramePickerInterface $picker, $isOutOfBand);

    /**
     * Write data to socket
     *
     * @param string $data Data to write
     * @param bool $isOutOfBand Flag if data are out of band
     *
     * @return int Number of written bytes
     */
    abstract protected function writeRawData($data, $isOutOfBand);

    /**
     * Check whether given socket resource is connected
     *
     * @return bool
     */
    abstract protected function isConnected();

    /**
     * Return true if frame can be collected in nearest future, false otherwise
     *
     * @return bool
     */
    abstract protected function canReachFrame();

    /**
     * Return remote socket ip address
     *
     * @return string
     */
    abstract protected function getRemoteAddress();

    /** {@inheritdoc} */
    final public function read(FramePickerInterface $picker, Context $context, $isOutOfBand)
    {
        $this->setConnectedState();
        $this->verifyOobData($isOutOfBand, null);

        $isEndOfFrameReached = $this->handleUnreadData($picker, $context, $isOutOfBand);
        if (!$isEndOfFrameReached) {
            $context->setUnreadData(
                $this->readRawDataIntoPicker($picker, $isOutOfBand),
                $isOutOfBand
            );

            $isEndOfFrameReached = $picker->isEof();
            if (!$isEndOfFrameReached && !$this->canReachFrame()) {
                throw new FrameException($picker, $this->socket, 'Failed to receive desired frame.');
            }
        }

        $frame = $picker->createFrame();
        if (!$isEndOfFrameReached) {
            $frame = new PartialFrame($frame);
        }

        return $frame;
    }

    /** {@inheritdoc} */
    final public function write($data, Context $context, $isOutOfBand)
    {
        $this->setConnectedState();
        $this->verifyOobData($isOutOfBand, $data);

        $result              = $this->writeRawData($data, $isOutOfBand);
        $this->writeAttempts = $result > 0 ? self::IO_ATTEMPTS : $this->writeAttempts - 1;

        $this->throwNetworkSocketExceptionIf(
            !$this->writeAttempts && $result !== strlen($data),
            'Failed to send data.'
        );

        return $result;
    }

    /**
     * Verifies given data according to OOB rules
     *
     * @param bool   $isOutOfBand Flag if data are out of band
     * @param string $data Accepted data or null to skip check
     *
     * @return void
     */
    private function verifyOobData($isOutOfBand, $data)
    {
        if ($isOutOfBand) {
            if ($this->maxOobPacketLength === 0) {
                throw UnsupportedOperationException::oobDataUnsupported($this->socket);
            }

            if ($data !== null && strlen($data) > $this->maxOobPacketLength) {
                throw UnsupportedOperationException::oobDataPackageSizeExceeded(
                    $this->socket,
                    $this->maxOobPacketLength,
                    strlen($data)
                );
            }
        }
    }

    /**
     * Verify, that we are in connected state
     *
     * @return void
     * @throws ConnectionException
     */
    private function setConnectedState()
    {
        $resource = $this->socket->getStreamResource();
        if (!is_resource($resource)) {
            $message = $this->state === self::STATE_CONNECTED ?
                'Connection was unexpectedly closed.' :
                'Can not start io operation on uninitialized socket.';
            throw new ConnectionException($this->socket, $message);
        }

        if ($this->state !== self::STATE_CONNECTED) {
            if (!$this->isConnected()) {
                throw new ConnectionException($this->socket, 'Connection refused.');
            }

            $this->state = self::STATE_CONNECTED;
        }
    }

    /**
     * Checks that we are in connected state
     *
     * @param string $message Message to pass in exception
     *
     * @return void
     * @throws NetworkSocketException
     */
    final protected function throwExceptionIfNotConnected($message)
    {
        $this->throwNetworkSocketExceptionIf(
            !$this->isConnected(),
            $message
        );
    }

    /**
     * Read unhandled data if there is something from the previous operation
     *
     * @param FramePickerInterface $picker Frame picker to use
     * @param Context              $context Socket context
     * @param bool                 $isOutOfBand Flag if it is out-of-band data
     *
     * @return bool Flag whether it is the end of the frame
     */
    private function handleUnreadData(FramePickerInterface $picker, Context $context, $isOutOfBand)
    {
        $unhandledData = $context->getUnreadData($isOutOfBand);
        if ($unhandledData) {
            $context->setUnreadData(
                $picker->pickUpData($unhandledData, $this->getRemoteAddress()),
                $isOutOfBand
            );
        }

        return $picker->isEof();
    }
}


1		<?php
2		/**
3		* Async sockets
4		*
5		* @copyright Copyright (c) 2015-2016, 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\ConnectionException;
13		use AsyncSockets\Exception\FrameException;
14		use AsyncSockets\Exception\NetworkSocketException;
15		use AsyncSockets\Exception\UnsupportedOperationException;
16		use AsyncSockets\Frame\FramePickerInterface;
17		use AsyncSockets\Frame\PartialFrame;
18		use AsyncSockets\Socket\SocketInterface;
19
20		/**
21		* Class AbstractClientIo
22		*/
23		abstract class AbstractClientIo extends AbstractIo
24		{
25		/**
26		* Disconnected state
27		*/
28		const STATE_DISCONNECTED = 0;
29
30		/**
31		* Connected state
32		*/
33		const STATE_CONNECTED = 1;
34
35		/**
36		* Socket state
37		*
38		* @var int
39		*/
40		private $state = self::STATE_DISCONNECTED;
41
42		/**
43		* Amount of attempts to write data before treat request as failed
44		*
45		* @var int
46		*/
47		private $writeAttempts = self::IO_ATTEMPTS;
48
49		/**
50		* Maximum amount of OOB data length (0 - not supported)
51		*
52		* @var int
53		*/
54		private $maxOobPacketLength;
55
56		/**
57		* AbstractClientIo constructor.
58		*
59		* @param SocketInterface $socket Socket object
60		* @param int $maxOobPacketLength Maximum amount of OOB data length (0 - not supported)
61		*/
62		public function __construct(SocketInterface $socket, $maxOobPacketLength)
63		{
64		parent::__construct($socket);
65		$this->maxOobPacketLength = $maxOobPacketLength;
66		}
67
68		/**
69	103	* Read raw data from network into given picker
70		*
71	103	* @param FramePickerInterface $picker Frame picker
72	103	* @param bool $isOutOfBand Flag if these are out of band data
73	103	*
74		* @return string Data after end of frame
75		*/
76		abstract protected function readRawDataIntoPicker(FramePickerInterface $picker, $isOutOfBand);
77
78		/**
79		* Write data to socket
80		*
81		* @param string $data Data to write
82		* @param bool $isOutOfBand Flag if data are out of band
83		*
84		* @return int Number of written bytes
85		*/
86		abstract protected function writeRawData($data, $isOutOfBand);
87
88		/**
89		* Check whether given socket resource is connected
90		*
91		* @return bool
92		*/
93		abstract protected function isConnected();
94
95		/**
96		* Return true if frame can be collected in nearest future, false otherwise
97		*
98		* @return bool
99		*/
100		abstract protected function canReachFrame();
101
102		/**
103		* Return remote socket ip address
104		*
105		* @return string
106		*/
107		abstract protected function getRemoteAddress();
108
109		/** {@inheritdoc} */
110		final public function read(FramePickerInterface $picker, Context $context, $isOutOfBand)
111		{
112		$this->setConnectedState();
113		$this->verifyOobData($isOutOfBand, null);
114
115		$isEndOfFrameReached = $this->handleUnreadData($picker, $context, $isOutOfBand);
116	46	if (!$isEndOfFrameReached) {
117		$context->setUnreadData(
118	46	$this->readRawDataIntoPicker($picker, $isOutOfBand),
119	40	$isOutOfBand
120	40	);
121	40
122		$isEndOfFrameReached = $picker->isEof();
123	39	if (!$isEndOfFrameReached && !$this->canReachFrame()) {
124	39	throw new FrameException($picker, $this->socket, 'Failed to receive desired frame.');
125	5	}
126		}
127	35
128		$frame = $picker->createFrame();
129	35	if (!$isEndOfFrameReached) {
130	35	$frame = new PartialFrame($frame);
131	2	}
132	2
133		return $frame;
134	35	}
135
136		/** {@inheritdoc} */
137		final public function write($data, Context $context, $isOutOfBand)
138	42	{
139		$this->setConnectedState();
140	42	$this->verifyOobData($isOutOfBand, $data);
141	26
142	13	$result = $this->writeRawData($data, $isOutOfBand);
143	8	$this->writeAttempts = $result > 0 ? self::IO_ATTEMPTS : $this->writeAttempts - 1;
144
145		$this->throwNetworkSocketExceptionIf(
146	5	!$this->writeAttempts && $result !== strlen($data),
147	5	'Failed to send data.'
148	4	);
149	4
150	4	return $result;
151		}
152	4
153		/**
154	1	* Verifies given data according to OOB rules
155		*
156	14	* @param bool $isOutOfBand Flag if data are out of band
157	7	* @param string $data Accepted data or null to skip check
158		*
159	7	* @return void
160	7	*/
161		private function verifyOobData($isOutOfBand, $data)
162	7	{
163		if ($isOutOfBand) {
164	7	if ($this->maxOobPacketLength === 0) {
165		throw UnsupportedOperationException::oobDataUnsupported($this->socket);
166		}
167
168		if ($data !== null && strlen($data) > $this->maxOobPacketLength) {
169		throw UnsupportedOperationException::oobDataPackageSizeExceeded(
170		$this->socket,
171		$this->maxOobPacketLength,
172		strlen($data)
173	88	);
174		}
175	88	}
176	88	}
177	20
178	20	/**
179	20	* Verify, that we are in connected state
180	20	*
181		* @return void
182		* @throws ConnectionException
183	68	*/
184	68	private function setConnectedState()
185	2	{
186		$resource = $this->socket->getStreamResource();
187		if (!is_resource($resource)) {
188	66	$message = $this->state === self::STATE_CONNECTED ?
189	66	'Connection was unexpectedly closed.' :
190	66	'Can not start io operation on uninitialized socket.';
191		throw new ConnectionException($this->socket, $message);
192		}
193
194		if ($this->state !== self::STATE_CONNECTED) {
195		if (!$this->isConnected()) {
196		throw new ConnectionException($this->socket, 'Connection refused.');
197		}
198
199		$this->state = self::STATE_CONNECTED;
200	2	}
201		}
202	2
203	2	/**
204		* Checks that we are in connected state
205	2	*
206	1	* @param string $message Message to pass in exception
207		*
208		* @return void
209		* @throws NetworkSocketException
210		*/
211		final protected function throwExceptionIfNotConnected($message)
212		{
213		$this->throwNetworkSocketExceptionIf(
214		!$this->isConnected(),
215	40	$message
216		);
217	40	}
218	9
219	9	/**
220		* Read unhandled data if there is something from the previous operation
221	40	*
222		* @param FramePickerInterface $picker Frame picker to use
223		* @param Context $context Socket context
224		* @param bool $isOutOfBand Flag if it is out-of-band data
225		*
226		* @return bool Flag whether it is the end of the frame
227		*/
228		private function handleUnreadData(FramePickerInterface $picker, Context $context, $isOutOfBand)
229		{
230		$unhandledData = $context->getUnreadData($isOutOfBand);
231		if ($unhandledData) {
232		$context->setUnreadData(
233		$picker->pickUpData($unhandledData, $this->getRemoteAddress()),
234		$isOutOfBand
235		);
236		}
237
238		return $picker->isEof();
239		}
240		}
241

edefimov / async-sockets

Branch — 0.4-dev (d01bc8)

AbstractClientIo::write() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like