AsyncSockets\Event\ReadEvent

Complexity

Total Complexity

4

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getFrame()	0	4	1
A	__construct()	0	11	1
A	isPartial()	0	4	1
A	isOutOfBand()	0	4	1

<?php
/**
 * Async sockets
 *
 * @copyright Copyright (c) 2015-2016, Efimov Evgenij <edefimov.it@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */
namespace AsyncSockets\Event;

use AsyncSockets\Frame\FrameInterface;
use AsyncSockets\Frame\PartialFrame;
use AsyncSockets\RequestExecutor\RequestExecutorInterface;
use AsyncSockets\Socket\SocketInterface;

/**
 * Class ReadEvent
 */
class ReadEvent extends IoEvent
{
    /**
     * Data read from network
     *
     * @var FrameInterface
     */
    private $frame;

    /**
     * Flag if data are out of band
     *
     * @var bool
     */
    private $isOutOfBand;

    /**
     * Constructor
     *
     * @param RequestExecutorInterface $executor Request executor object
     * @param SocketInterface          $socket Socket for this request
     * @param mixed                    $context Any optional user data for event
     * @param FrameInterface           $frame Network data for read operation
     * @param bool                     $isOutOfBand Flag if data are out of band
     */
    public function __construct(
        RequestExecutorInterface $executor,
        SocketInterface $socket,
        $context,
        FrameInterface $frame,
        $isOutOfBand = false
    ) {
        parent::__construct($executor, $socket, $context, EventType::READ);
        $this->frame       = $frame;
        $this->isOutOfBand = $isOutOfBand;
    }

    /**
     * Return response frame
     *
     * @return FrameInterface
     */
    public function getFrame()
    {
        return $this->frame;
    }

    /**
     * Return true, if frame in this event is partial
     *
     * @return bool
     */
    public function isPartial()
    {
        return $this->frame instanceof PartialFrame;
    }

    /**
     * Return true if data are out of band
     *
     * @return bool
     */
    public function isOutOfBand()
    {
        return $this->isOutOfBand;
    }
}