Transport.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Transport;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter;
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\TransportException;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper;

abstract class Transport
{
    protected array $config;

    protected $stream = null;

    protected $session = null;

    protected ?Adapter $adapter = null;

    public function __construct(array $config)
    {
        if (!array_key_exists("host", $config)) {
            throw new TransportException("config must have a key for 'host' which specifies the server host name");
        }
 
        if (!array_key_exists("port", $config)) {
            throw new TransportException("config must have a key for 'port' which specifies the server port number");
        }
 
        if (!array_key_exists("timeout", $config)) {
            $config["timeout"] = 10;
        }
 
        if (!array_key_exists("blocking", $config)) {
            $config["blocking"] = 1;
        }
 
        $this->config = $config;
        return $this;
    }

    public function __sleep()
    {
        return ["config"];
    }

    public function __wakeup()
    {
        $this->connect();
    }

    public function __destruct()
    {
        if ($this->adapter instanceof Adapter) {
            $this->adapter->__destruct();
        }
 
        $this->disconnect();
    }

    abstract public function connect(): void;

    abstract public function disconnect(): void;

    abstract public function read(int $length = 4096): StringHelper;

    abstract public function send(string $data): void;

    public function getStream()
    {
        return $this->stream;
    }

    public function getConfig(string $key = null, mixed $default = null): array|string|int
    {
        if ($key !== null) {
            return array_key_exists($key, $this->config) ? $this->config[$key] : $default;
        }
 
        return $this->config;
    }

    public function setAdapter(Adapter $adapter): void
    {
        $this->adapter = $adapter;
    }

    public function getAdapter(): ?Adapter
    {
        return $this->adapter;
    }

    public function getAdapterType(): string
    {
        if ($this->adapter instanceof Adapter) {
            $string = StringHelper::factory(get_class($this->adapter));
 
            return $string->substr($string->findLast("\\"))->replace(["\\", " "], "")->toString();
        }
 
        return "Unknown";
    }

    public function getMetaData(): array
    {
        if ($this->stream === null) {
            throw new TransportException("unable to retrieve header/meta data from stream pointer");
        }
 
        return stream_get_meta_data($this->stream);
    }

    public function isConnected(): bool
    {
        return ($this->getStream() === null) ? false : true;
    }

    protected function waitForReadyRead(int $time = 0): void
    {
        if (!$this->isConnected() || $this->config["blocking"]) {
            return;
        }
 
        do {
            $read = [$this->stream];
            $null = null;
 
            if ($time) {
                Signal::getInstance()
                    ->emit(strtolower($this->getAdapterType()) . "WaitTimeout", $time, $this->getAdapter());
            }
 
            $time = $time + $this->config["timeout"];
        } while (@stream_select($read, $null, $null, $this->config["timeout"]) == 0);
    }
}