Plugin and Module interfaces rename

README.md

@@ -43,7 +43,7 @@ use Amp\Http\Server\HttpErrorException;
 use Amp\Http\Server\Request;
 use Amp\Http\Server\RequestHandler\ClosureRequestHandler;
 use Amp\Http\Server\Response;
-use Luzrain\PHPStreamServer\Plugin\HttpServer\HttpServer;
+use Luzrain\PHPStreamServer\Plugin\HttpServer\HttpServerModule;
 use Luzrain\PHPStreamServer\Plugin\HttpServer\Listen;
 use Luzrain\PHPStreamServer\Server;
 use Luzrain\PHPStreamServer\WorkerProcess;
@@ -61,7 +61,7 @@ $server->addWorkersProcess(new WorkerProcess(
             };
         });
 
-        $worker->startPlugin(new HttpServer(
+        $worker->startWorkerModule(new HttpServerModule(
             listen: new Listen(listen: '0.0.0.0:8087'),
             requestHandler: $requestHandler,
         ));

src/Internal/MasterProcess.php

@@ -13,7 +13,7 @@
 use Luzrain\PHPStreamServer\Internal\ServerStatus\ServerStatus;
 use Luzrain\PHPStreamServer\Internal\Supervisor\Supervisor;
 use Luzrain\PHPStreamServer\PeriodicProcess;
-use Luzrain\PHPStreamServer\Plugin\Module;
+use Luzrain\PHPStreamServer\Plugin\Plugin;
 use Luzrain\PHPStreamServer\Server;
 use Luzrain\PHPStreamServer\WorkerProcess;
 use Psr\Log\LoggerInterface;
@@ -41,9 +41,9 @@ final class MasterProcess
     private Scheduler $scheduler;
 
     /**
-     * @var array<class-string<Module>, Module>
+     * @var array<class-string<Plugin>, Plugin>
      */
-    private array $modules = [];
+    private array $plugins = [];
 
     public function __construct(
         string|null $pidFile,
@@ -94,14 +94,14 @@ public function addPeriodicProcess(PeriodicProcess...$workers): void
         }
     }
 
-    public function addModules(Module ...$modules): void
+    public function addPlugins(Plugin ...$plugins): void
     {
-        foreach ($modules as $module) {
+        foreach ($plugins as $module) {
             $hash = \hash('xxh128', $module::class);
-            if (isset($this->modules[$hash])) {
+            if (isset($this->plugins[$hash])) {
                 throw new PHPStreamServerException('Can not load more than one instance of the same module');
             }
-            $this->modules[$hash] = $module;
+            $this->plugins[$hash] = $module;
         }
     }
 
@@ -181,7 +181,7 @@ private function start(): void
             \gc_mem_caches();
         });
 
-        foreach ($this->modules as $module) {
+        foreach ($this->plugins as $module) {
             $module->start($this);
         }
     }
@@ -256,7 +256,7 @@ public function stop(int $code = 0): void
         $stopFutures = [];
         $stopFutures[] = $this->supervisor->stop();
         $stopFutures[] = $this->scheduler->stop();
-        foreach ($this->modules as $module) {
+        foreach ($this->plugins as $module) {
             $stopFutures[] = $module->stop();
         }
 
@@ -305,7 +305,7 @@ private function getStatus(): Status
 
     private function free(): void
     {
-        unset($this->modules);
+        unset($this->plugins);
         unset($this->serverStatus);
         unset($this->messageHandler);
         unset($this->supervisor);

src/Plugin/FileMonitor/FileMonitor.php

@@ -6,10 +6,10 @@
 
 use Amp\Future;
 use Luzrain\PHPStreamServer\Internal\MasterProcess;
-use Luzrain\PHPStreamServer\Plugin\Module;
+use Luzrain\PHPStreamServer\Plugin\Plugin;
 use function Amp\async;
 
-final readonly class FileMonitor implements Module
+final readonly class FileMonitor implements Plugin
 {
     public function __construct(
         private string $sourceDir,

src/Plugin/HttpServer/HttpServer.php → src/Plugin/HttpServer/HttpServerModule.php

@@ -22,17 +22,16 @@
 use Luzrain\PHPStreamServer\Plugin\HttpServer\Internal\Middleware\ReloadStrategyTriggerMiddleware;
 use Luzrain\PHPStreamServer\Plugin\HttpServer\Internal\Middleware\RequestsCounterMiddleware;
 use Luzrain\PHPStreamServer\Plugin\HttpServer\Middleware\StaticMiddleware;
-use Luzrain\PHPStreamServer\Plugin\Plugin;
+use Luzrain\PHPStreamServer\Plugin\WorkerModule;
 use Luzrain\PHPStreamServer\WorkerProcess;
 use Luzrain\PHPStreamServer\WorkerProcessInterface;
 
-final readonly class HttpServer implements Plugin
+final readonly class HttpServerModule implements WorkerModule
 {
     private const DEFAULT_TCP_BACKLOG = 65536;
 
     /**
      * @param Listen|array<Listen> $listen
-     * @param RequestHandler $requestHandler
      * @param array<Middleware> $middleware
      * @param positive-int|null $connectionLimit
      * @param positive-int|null $connectionLimitPerIp

src/Plugin/Plugin.php

@@ -4,9 +4,18 @@
 
 namespace Luzrain\PHPStreamServer\Plugin;
 
-use Luzrain\PHPStreamServer\WorkerProcessInterface;
+use Amp\Future;
+use Luzrain\PHPStreamServer\Internal\MasterProcess;
 
 interface Plugin
 {
-    public function start(WorkerProcessInterface $worker): void;
+    /**
+     * Initialize module before event loop starts
+     */
+    public function start(MasterProcess $masterProcess): void;
+
+    /**
+     * If module has to finish some work right before server stop, master process will wait for it
+     */
+    public function stop(): Future;
 }

src/Plugin/WorkerModule.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Luzrain\PHPStreamServer\Plugin;
+
+use Luzrain\PHPStreamServer\WorkerProcessInterface;
+
+interface WorkerModule
+{
+    public function start(WorkerProcessInterface $worker): void;
+}

src/Server.php

@@ -14,7 +14,7 @@
 use Luzrain\PHPStreamServer\Console\App;
 use Luzrain\PHPStreamServer\Internal\Logger\Logger;
 use Luzrain\PHPStreamServer\Internal\MasterProcess;
-use Luzrain\PHPStreamServer\Plugin\Module;
+use Luzrain\PHPStreamServer\Plugin\Plugin;
 
 final class Server
 {
@@ -57,9 +57,9 @@ public function addPeriodicProcess(PeriodicProcess ...$workers): self
         return $this;
     }
 
-    public function addModules(Module ...$module): self
+    public function addPlugins(Plugin ...$plugin): self
     {
-        $this->masterProcess->addModules(...$module);
+        $this->masterProcess->addPlugins(...$plugin);
 
         return $this;
     }

src/WorkerProcess.php

@@ -13,7 +13,7 @@
 use Luzrain\PHPStreamServer\Internal\ServerStatus\Message\Heartbeat;
 use Luzrain\PHPStreamServer\Internal\ServerStatus\Message\Spawn;
 use Luzrain\PHPStreamServer\Internal\ServerStatus\TrafficStatus;
-use Luzrain\PHPStreamServer\Plugin\Plugin;
+use Luzrain\PHPStreamServer\Plugin\WorkerModule;
 use Luzrain\PHPStreamServer\ReloadStrategy\ReloadStrategy;
 use Revolt\EventLoop;
 use Revolt\EventLoop\DriverFactory;
@@ -152,8 +152,8 @@ public function addReloadStrategies(ReloadStrategy ...$reloadStrategies): void
         $this->reloadStrategyTrigger->addReloadStrategies(...$reloadStrategies);
     }
 
-    public function startPlugin(Plugin $plugin): void
+    public function startWorkerModule(WorkerModule $module): void
     {
-        $plugin->start($this);
+        $module->start($this);
     }
 }

src/WorkerProcessInterface.php

@@ -5,7 +5,7 @@
 namespace Luzrain\PHPStreamServer;
 
 use Luzrain\PHPStreamServer\Internal\RunnableProcess;
-use Luzrain\PHPStreamServer\Plugin\Plugin;
+use Luzrain\PHPStreamServer\Plugin\WorkerModule;
 use Luzrain\PHPStreamServer\ReloadStrategy\ReloadStrategy;
 
 interface WorkerProcessInterface extends ProcessInterface, RunnableProcess
@@ -26,7 +26,7 @@ public function reload(): void;
     public function addReloadStrategies(ReloadStrategy ...$reloadStrategies): void;
 
     /**
-     * Start plugin in this worker
+     * Start worker module in this worker
      */
-    public function startPlugin(Plugin $plugin): void;
+    public function startWorkerModule(WorkerModule $module): void;
 }