ykxiao/laravel-matt-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the package for v1 of the MQTT client (#1)

Browse Source 
* Update composer packages and untrack composer.lock

* Update code and config for v1.0.0-rc1

* Use contract instead of implementation

* Update README.md
This commit is contained in:
Namoshek
2021-01-05 17:05:06 +01:00
committed by GitHub
parent 2ea0c4cd2c
commit 78af7a1889
9 changed files with 198 additions and 792 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
src/ConnectionManager.php
View File

@ -6,10 +6,15 @@ namespace PhpMqtt\Client;
use Illuminate\Contracts\Container\BindingResolutionException;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Arr;
use PhpMqtt\Client\Contracts\MqttClient as MqttClientContract;
use PhpMqtt\Client\Contracts\Repository;
use PhpMqtt\Client\Exceptions\ConfigurationInvalidException;
use PhpMqtt\Client\Exceptions\ConnectingToBrokerFailedException;
use PhpMqtt\Client\Exceptions\ConnectionNotAvailableException;
use PhpMqtt\Client\Exceptions\DataTransferException;
use PhpMqtt\Client\Exceptions\ProtocolNotSupportedException;
use PhpMqtt\Client\Exceptions\RepositoryException;
/**
* Manages the MQTT connections of the application.
@ -18,17 +23,12 @@ use PhpMqtt\Client\Exceptions\DataTransferException;
*/
class ConnectionManager
{
/** @var Application */
protected $application;
private Application $application;
private array $config;
private string $defaultConnection;
/** @var array */
protected $config;
/** @var string */
protected $defaultConnection;
/** @var MQTTClient[] */
protected $connections = [];
/** @var MqttClientContract[] */
private array $connections = [];
/**
* ConnectionManager constructor.
@ -40,19 +40,21 @@ class ConnectionManager
{
$this->application = $application;
$this->config = $config;
$this->defaultConnection = array_get($config, 'default_connection', 'default');
$this->defaultConnection = Arr::get($config, 'default_connection', 'default');
}
/**
* Gets the connection with the specified name.
*
* @param string|null $name
* @return MQTTClient
* @return MqttClientContract
* @throws BindingResolutionException
* @throws ConfigurationInvalidException
* @throws ConnectingToBrokerFailedException
* @throws ConnectionNotAvailableException
* @throws ProtocolNotSupportedException
*/
public function connection(string $name = null): MQTTClient
public function connection(string $name = null): MqttClientContract
{
if ($name === null) {
$name = $this->defaultConnection;
@ -71,90 +73,104 @@ class ConnectionManager
* @param string|null $connection
* @throws DataTransferException
*/
public function close(string $connection = null): void
public function disconnect(string $connection = null): void
{
if ($connection === null) {
$connection = $this->defaultConnection;
}
if (array_key_exists($connection, $this->connections)) {
$this->connections[$connection]->close();
$this->connections[$connection]->disconnect();
unset($this->connections[$connection]);
}
}
/**
* Publishes a message on the given connection. The QoS level will be 0
* and the message will not be retained by the broker.
* Publishes a message on the given connection. The QoS level will be 0.
*
* @param string $topic
* @param string $message
* @param bool $retain
* @param string|null $connection
* @throws BindingResolutionException
* @throws ConfigurationInvalidException
* @throws ConnectingToBrokerFailedException
* @throws ConnectionNotAvailableException
* @throws DataTransferException
* @throws ProtocolNotSupportedException
* @throws RepositoryException
*/
public function publish(string $topic, string $message, string $connection = null): void
public function publish(string $topic, string $message, bool $retain = false, string $connection = null): void
{
$client = $this->connection($connection);
$client->publish($topic, $message);
$client->publish($topic, $message, MqttClient::QOS_AT_MOST_ONCE, $retain);
}
/**
* Creates a new MQTT client and connects to the specified server.
*
* @param string $name
* @return MQTTClient
* @return MqttClientContract
* @throws BindingResolutionException
* @throws ConfigurationInvalidException
* @throws ConnectingToBrokerFailedException
* @throws ConnectionNotAvailableException
* @throws ProtocolNotSupportedException
*/
protected function createConnection(string $name): MQTTClient
protected function createConnection(string $name): MqttClientContract
{
$config = array_get($this->config, "connections.{$name}");
$config = Arr::get($this->config, "connections.{$name}");
if ($config === null) {
throw new ConnectionNotAvailableException($name);
}
$host = array_get($config, 'host');
$port = array_get($config, 'port', 1883);
$username = array_get($config, 'username');
$password = array_get($config, 'password');
$clientId = array_get($config, 'client_id');
$caFile = array_get($config, 'cafile');
$cleanSession = array_get($config, 'clean_session', true);
$loggingEnabled = array_get($config, 'logging_enabled', true);
$repository = array_get($config, 'repository', Repository::class);
$host = Arr::get($config, 'host');
$port = Arr::get($config, 'port', 1883);
$clientId = Arr::get($config, 'client_id');
$protocol = Arr::get($config, 'protocol', MqttClient::MQTT_3_1);
$cleanSession = Arr::get($config, 'use_clean_session', true);
$repository = Arr::get($config, 'repository', Repository::class);
$loggingEnabled = Arr::get($config, 'enable_logging', true);
$settings = $this->parseConnectionSettings(array_get($config, 'settings', []));
$settings = $this->buildConnectionSettings(Arr::get($config, 'connection_settings', []));
$repository = $this->application->make($repository);
$logger = $loggingEnabled ? $this->application->make('log') : null;
$client = new MQTTClient($host, $port, $clientId, $caFile, $repository, $logger);
$client->connect($username, $password, $settings, $cleanSession);
$client = new MqttClient($host, $port, $clientId, $protocol, $repository, $logger);
$client->connect($settings, $cleanSession);
return $client;
}
/**
* Parses the given settings and returns a populated settings object.
* Builds the {@see ConnectionSettings} for the connection specified by the given config.
*
* @param array $settings
* @param array $config
* @return ConnectionSettings
*/
protected function parseConnectionSettings(array $settings): ConnectionSettings
protected function buildConnectionSettings(array $config): ConnectionSettings
{
$qos = array_get($settings, 'quality_of_service', 0);
$blockSocket = array_get($settings, 'block_socket', false);
$keepAlive = array_get($settings, 'keep_alive', 10);
$socketTimeout = array_get($settings, 'socket_timeout', 5);
$resendTimeout = array_get($settings, 'resend_timeout', 10);
$retain = array_get($settings, 'retain', false);
$lastWillTopic = array_get($settings, 'last_will_topic');
$lastWillMessage = array_get($settings, 'last_will_message');
return new ConnectionSettings($qos, $retain, $blockSocket, $socketTimeout, $keepAlive, $resendTimeout, $lastWillTopic, $lastWillMessage);
return (new ConnectionSettings)
->setConnectTimeout(Arr::get($config, 'connect_timeout', 60))
->setSocketTimeout(Arr::get($config, 'socket_timeout', 5))
->setResendTimeout(Arr::get($config, 'resend_timeout', 10))
->setKeepAliveInterval(Arr::get($config, 'keep_alive_interval', 10))
->setUsername(Arr::get($config, 'auth.username'))
->setPassword(Arr::get($config, 'auth.password'))
->setUseTls(Arr::get($config, 'tls.enabled', false))
->setTlsSelfSignedAllowed(Arr::get($config, 'tls.allow_self_signed_certificate', false))
->setTlsVerifyPeer(Arr::get($config, 'tls.verify_peer', true))
->setTlsVerifyPeerName(Arr::get($config, 'tls.verify_peer_name', true))
->setTlsCertificateAuthorityFile(Arr::get($config, 'tls.ca_file'))
->setTlsCertificateAuthorityPath(Arr::get($config, 'tls.ca_path'))
->setTlsClientCertificateFile(Arr::get($config, 'tls.client_certificate_file'))
->setTlsClientCertificateKeyFile(Arr::get($config, 'tls.client_certificate_key_file'))
->setTlsClientCertificateKeyPassphrase(Arr::get($config, 'tls.client_certificate_key_passphrase'))
->setLastWillTopic(Arr::get($config, 'last_will.topic'))
->setLastWillMessage(Arr::get($config, 'last_will.message'))
->setLastWillQualityOfService(Arr::get($config, 'last_will.quality_of_service', MqttClient::QOS_AT_MOST_ONCE))
->setRetainLastWill(Arr::get($config, 'last_will.retain', false));
}
}

2
src/Exceptions/ConnectionNotAvailableException.php
View File

@ -9,7 +9,7 @@ namespace PhpMqtt\Client\Exceptions;
*
* @package PhpMqtt\Client\Exceptions
*/
class ConnectionNotAvailableException extends MQTTClientException
class ConnectionNotAvailableException extends MqttClientException
{
public function __construct(string $name)
{

8
src/Facades/MQTT.php
View File

@ -6,12 +6,12 @@ namespace PhpMqtt\Client\Facades;
use Illuminate\Support\Facades\Facade;
use PhpMqtt\Client\ConnectionManager;
use PhpMqtt\Client\MQTTClient;
use PhpMqtt\Client\Contracts\MqttClient;
/**
* @method static MQTTClient connection(string $name = null)
* @method static void close(string $connection = null)
* @method static void publish(string $topic, string $message, string $connection = null)
* @method static MqttClient connection(string $name = null)
* @method static void disconnect(string $connection = null)
* @method static void publish(string $topic, string $message, bool $retain = false, string $connection = null)
*
* @see ConnectionManager
* @package PhpMqtt\Client\Facades

19
src/MqttClientServiceProvider.php
View File

@ -21,24 +21,26 @@ class MqttClientServiceProvider extends ServiceProvider
*/
public function register(): void
{
$this->registerConfig();
$this->mergeConfigFrom(__DIR__ . '/../config/mqtt-client.php', 'mqtt-client');
$this->registerServices();
}
/**
* Publishes and merges the configuration of the package.
* Bootstrap any application services.
*
* @return void
* @throws \BadFunctionCallException
*/
protected function registerConfig(): void
public function boot(): void
{
$configPath = __DIR__ . '/../config/mqtt-client.php';
if ($this->app->runningInConsole()) {
$this->publishes([$configPath => config_path('mqtt-client.php')], 'config');
if (!function_exists('config_path')) {
throw new \BadFunctionCallException('config_path() function not found. Is the Laravel framework installed?');
}
$this->mergeConfigFrom($configPath, 'mqtt-client');
if ($this->app->runningInConsole()) {
$this->publishes([__DIR__ . '/../config/mqtt-client.php' => config_path('mqtt-client.php')], 'config');
}
}
/**
@ -50,6 +52,7 @@ class MqttClientServiceProvider extends ServiceProvider
{
$this->app->bind(ConnectionManager::class, function (Application $app) {
$config = $app->make('config')->get('mqtt-client', []);
return new ConnectionManager($app, $config);
});