AsyncSockets\Event\Event

Complexity

Total Complexity

7

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getSocket()	0	4	1
A	getContext()	0	4	1
A	getExecutor()	0	4	1
A	getType()	0	4	1
A	isOperationCancelled()	0	4	1
A	__construct()	0	8	1
A	cancelThisOperation()	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\RequestExecutor\RequestExecutorInterface;
use AsyncSockets\Socket\SocketInterface;

/**
 * Class Event
 *
 * @api
 */
class Event extends AbstractEvent
{
    /**
     * Socket linked to this event
     *
     * @var SocketInterface
     */
    private $socket;

    /**
     * User data for this event
     *
     * @var mixed
     */
    private $context;

    /**
     * Request executor
     *
     * @var RequestExecutorInterface
     */
    private $executor;

    /**
     * This event type
     *
     * @var string
     */
    private $type;

    /**
     * Flag to stop this socket request
     *
     * @var bool
     */
    private $isCancelled;

    /**
     * Constructor
     *
     * @param RequestExecutorInterface $executor Request executor object
     * @param SocketInterface          $socket   Socket for this request
     * @param mixed                    $context  Any optional user data for event
     * @param string                   $type One of EventType::* constants
     */
    public function __construct(RequestExecutorInterface $executor, SocketInterface $socket, $context, $type)
    {
        $this->executor    = $executor;
        $this->socket      = $socket;
        $this->context     = $context;
        $this->type        = $type;
        $this->isCancelled = false;
    }

    /**
     * Return associated socket
     *
     * @return SocketInterface
     */
    public function getSocket()
    {
        return $this->socket;
    }

    /**
     * Return user specified context
     *
     * @return mixed
     */
    public function getContext()
    {
        return $this->context;
    }

    /**
     * Return RequestExecutor
     *
     * @return RequestExecutorInterface
     */
    public function getExecutor()
    {
        return $this->executor;
    }

    /**
     * Return type of this event
     *
     * @return string One of EventType::* consts
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Return flag whether this socket operation is cancelled
     *
     * @return boolean
     */
    public function isOperationCancelled()
    {
        return $this->isCancelled;
    }

    /**
     * Sets cancel this operation flag
     *
     * @param boolean $isCancelled Cancel flag
     *
     * @return void
     */
    public function cancelThisOperation($isCancelled = true)
    {
        $this->isCancelled = $isCancelled;
    }
}