summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/scheduler/src/Contract/Task.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ipl/scheduler/src/Contract/Task.php')
-rw-r--r--vendor/ipl/scheduler/src/Contract/Task.php39
1 files changed, 39 insertions, 0 deletions
diff --git a/vendor/ipl/scheduler/src/Contract/Task.php b/vendor/ipl/scheduler/src/Contract/Task.php
new file mode 100644
index 0000000..db09ddc
--- /dev/null
+++ b/vendor/ipl/scheduler/src/Contract/Task.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace ipl\Scheduler\Contract;
+
+use Ramsey\Uuid\UuidInterface;
+use React\Promise\ExtendedPromiseInterface;
+
+interface Task
+{
+ /**
+ * Get the name of this task
+ *
+ * @return string
+ */
+ public function getName(): string;
+
+ /**
+ * Get unique identifier of this task
+ *
+ * @return UuidInterface
+ */
+ public function getUuid(): UuidInterface;
+
+ /**
+ * Get the description of this task
+ *
+ * @return ?string
+ */
+ public function getDescription(): ?string;
+
+ /**
+ * Run this tasks operations
+ *
+ * This commits the actions in a non-blocking fashion to the event loop and yields a deferred promise
+ *
+ * @return ExtendedPromiseInterface
+ */
+ public function run(): ExtendedPromiseInterface;
+}