Igni\Http\Server\HttpConfiguration

Complexity

Total Complexity

14

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Test Coverage

Coverage

88.1%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	setMaximumBacklog()	0	3	1
A	enableSsl()	0	5	1
A	setLogFile()	0	4	1
A	isDaemonEnabled()	0	3	2
A	setMaxConnections()	0	3	1
A	setDispatchMode()	0	3	1
A	getSettings()	0	3	1
A	__construct()	0	4	1
A	setWorkers()	0	3	1
A	setUploadDir()	0	3	1
A	enableDaemon()	0	5	1
A	setMaxRequests()	0	3	1
A	isSslEnabled()	0	3	1

<?php declare(strict_types=1);

namespace Igni\Http\Server;

/**
 * Class HttpConfiguration
 * @package Igni\Http\Server
 */
class HttpConfiguration
{
    public const DISPATCH_ROUND_ROBIN = 1;
    public const DISPATCH_MODULO = 2;
    public const DISPATCH_PREEMPTIVE_ASSIGNMENT = 3;
    public const DEFAULT_ADDRESS = '0.0.0.0';
    public const DEFAULT_PORT = 80;
    public const LOG_DEBUG = 0;
    public const LOG_TRACE = 1;
    public const LOG_INFO = 2;
    public const LOG_NOTICE = 3;
    public const LOG_WARNING = 4;
    public const LOG_ERROR = 5;

    /**
     * @var array
     */
    private $settings = [];

    /**
     * HttpConfiguration constructor.
     *
     * @param string $address
     * @param int $port
     */
    public function __construct(string $address = self::DEFAULT_ADDRESS, int $port = self::DEFAULT_PORT)
    {
        $this->settings['address'] = $address;
        $this->settings['port'] = $port;
    }

    /**
     * Checks if ssl is enabled.
     *
     * @return bool
     */
    public function isSslEnabled(): bool
    {
        return isset($this->settings['ssl_cert_file']);
    }

    /**
     * Enables ssl on the server
     *
     * @param string $certFile
     * @param string $keyFile
     */
    public function enableSsl(string $certFile, string $keyFile): void
    {
        $this->settings += [
            'ssl_cert_file' => $certFile,
            'ssl_key_file' => $keyFile,
        ];
    }

    /**
     * Checks if server is daemonized.
     *
     * @return bool
     */
    public function isDaemonEnabled(): bool
    {
        return isset($this->settings['daemonize']) && $this->settings['daemonize'];
    }

    /**
     * Sets the max tcp connection number of the server.
     *
     * @param int $max
     */
    public function setMaxConnections(int $max = 10000): void
    {
        $this->settings['max_conn'] = $max;
    }

    /**
     * Sets the number of worker processes.
     *
     * @param int $count
     */
    public function setWorkers(int $count = 1): void
    {
        $this->settings['worker_num'] = $count;
    }

    /**
     * Sets the number of requests processed by the worker process before been recycled.
     *
     * @param int $max
     */
    public function setMaxRequests(int $max = 0): void
    {
        $this->settings['max_request'] = $max;
    }

    /**
     * Sets path to the file that will be used to persist server log.
     * Log level can also be set as an additional parameter.
     *
     * @param string $filename
     * @param int $logLevel
     */
    public function setLogFile(string $filename, int $logLevel = self::LOG_TRACE): void
    {
        $this->settings['log_file'] = $filename;
        $this->settings['log_level'] = $logLevel;
    }

    /**
     * Sets the maximum number of pending connections. This refers to the number of clients
     * that can be waiting to be served. Exceeding this number results in the client getting
     * an error when attempting to connect.
     *
     * @param int $max
     */
    public function setMaximumBacklog(int $max = 0): void
    {
        $this->settings['backlog'] = $max;
    }

    /**
     * Sets dispatch mode for child processes.
     *
     * @param int $mode
     */
    public function setDispatchMode(int $mode = self::DISPATCH_ROUND_ROBIN): void
    {
        $this->settings['dispatch_mode'] = $mode;
    }

    /**
     * Allows server to be run as a background process.
     *
     * @param string $pid
     */
    public function enableDaemon(string $pid): void
    {
        $this->settings += [
            'daemonize' => true,
            'pid_file' => $pid,
        ];
    }

    /**
     * Sets temporary dir for uploaded files
     *
     * @param string $dir
     */
    public function setUploadDir(string $dir): void
    {
        $this->settings['upload_tmp_dir'] = $dir;
    }

    /**
     * Returns swoole compatible settings array.
     *
     * @return array
     */
    public function getSettings(): array
    {
        return $this->settings;
    }
}