(pkg) init commit

Author: troublete

.gitignore

@@ -0,0 +1,2 @@
+vendor
+composer.lock

.travis.yml

@@ -0,0 +1,8 @@
+language: php
+php:
+  - '7.0'
+  - '7.1'
+before_script: 
+  - composer install --dev
+script:
+  - vendor/bin/codecept run

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 18.10.2017
+### [Added]
+
+* added methods for forking tasks of, closing them, and checking on them. 
+* added docs
+* added rudimental test

README.md

@@ -0,0 +1,97 @@
+# task
+
+> A PHP process forking and fork handling library.
+
+[![Build Status](https://travis-ci.org/troublete/load.svg?branch=master)](https://travis-ci.org/troublete/task)
+
+## Install
+
+```bash
+$ composer require troublete/task
+```
+
+## Usage
+
+```php
+<?php
+require_once '/path/to/autoload.php';
+
+use function Task\{forkTask, checkFail, checkSuccess};
+
+$pid = forkTask(function () {
+	// do something that is only happening in the forked process
+});
+
+// continue work...
+
+checkFail($pid); // to check if the process failed 
+checkSuccess($pid); // to check if the process finished with great success
+```
+
+## API
+
+### Functions
+
+#### forkTask($taskClosure)
+
+Function to fork off a child process. Returns the `pid` of the forked off process if successfull, throws an Exception if forking was not possible.
+
+##### Arguments
+
+| Argument | Type | Description |
+|---|---|---|
+| $taskClosure | `callable` | Closure function that is only executed in the child process |
+
+#### getProcessStatus($processId = null)
+
+Function that returns that status of a forked child by process id. If provided process id is null it'll return `0`.
+
+##### Arguments
+
+| Argument | Type | Description |
+|---|---|---|
+| $processId | `int` | Id of the process to be checked |
+
+#### checkAvailable($processId = null)
+
+Function to check if a process exists.
+
+##### Arguments
+
+| Argument | Type | Description |
+|---|---|---|
+| $processId | `int` | Id of the process to be checked |
+
+#### checkSuccess($processId = null)
+
+Function that returns based on the process status if a process already finished with great success. If the return value of this is `false` it does not necessarily mean that the process failed though. Since this is a non blocking process check. It is just not successfully finished at the point of the check.
+
+##### Arguments
+
+| Argument | Type | Description |
+|---|---|---|
+| $processId | `int` | Id of the process to be checked |
+
+#### checkFail($processId = null)
+
+Function that checks if a processed failed. If the return value is `false` it does not mean that the process didnt fail. Since this is a non blocking check, it is just not failed in the moment of the check.
+
+##### Arguments
+
+| Argument | Type | Description |
+|---|---|---|
+| $processId | `int` | Id of the process to be checked |
+
+#### closeTask($processId = null)
+
+Function to close a forked process. Returns `true` if successfull. 
+
+##### Arguments
+
+| Argument | Type | Description |
+|---|---|---|
+| $processId | `int` | Id of the process to be checked |
+
+## License
+
+GPL-2.0 © Willi Eßer

codeception.yml

@@ -0,0 +1,10 @@
+paths:
+    tests: tests
+    output: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+actor_suffix: Tester
+extensions:
+    enabled:
+        - Codeception\Extension\RunFailed

composer.json

@@ -0,0 +1,24 @@
+{
+    "name": "troublete/task",
+    "description": "A PHP process forking and fork handling library.",
+    "type": "library",
+    "license": "GPL-2.0",
+    "authors": [
+        {
+            "name": "Willi Eßer",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "stable",
+    "autoload": {
+    	"files": [
+    		"./task.php"
+    	]
+    },
+    "require": {
+    	"php": ">=7.0"
+    },
+    "require-dev": {
+        "codeception/codeception": "^2.3"
+    }
+}

task.php

@@ -0,0 +1,77 @@
+<?php
+namespace Task;
+
+/**
+ * Function to fork a task from the main thread, execute its task and return the pid
+ * @param callable $taskClosure
+ * @return mixed
+ */
+function forkTask(callable $taskClosure) {
+	$processId = pcntl_fork();
+	if ($processId === -1) {
+		throw new Exception('The task could not be forked off.');
+	}
+
+	if (
+		$processId !== -1
+		&& $processId !== 0
+	) {		
+		return $processId;
+	}
+
+	if ($processId === 0) {
+		call_user_func($taskClosure);
+	}	
+}
+
+/**
+ * Function to check the status of a process by process id
+ * @param int $processId
+ * @return int|null
+ */
+function getProcessStatus($processId = null) {
+	if ($processId === null) {
+		return null;
+	}
+
+	return pcntl_waitpid($processId, $status, WNOHANG);
+}
+
+/**
+ * Function to check if a process exists
+ * @param int|null $processId
+ * @return bool
+ */
+function checkAvailable($processId = null): bool {
+	$state = getProcessStatus($processId);
+	return $state !== null;
+}
+
+/**
+ * Function to check if a process succeeded
+ * @param int|null $processId
+ * @return bool
+ */
+function checkSuccess($processId = null): bool {
+	$state = getProcessStatus($processId);
+	return $state !== null && $state !== -1;
+}
+
+/**
+ * Function to check if a process failed
+ * @param int|null $processId
+ * @return bool
+ */
+function checkFail($processId = null): bool {
+	$state = getProcessStatus($processId);
+	return $state === -1;
+}
+
+/**
+ * Function to close a fork by process id
+ * @param int $processId
+ * @return bool
+ */
+function closeTask(int $processId): bool {
+	return posix_kill($processId, SIGQUIT);
+}

tests/_data/.gitkeep

@@ -0,0 +1,2 @@
+*
+!.gitignore

tests/_output/.gitignore

@@ -0,0 +1,10 @@
+<?php
+namespace Helper;
+
+// here you can define custom actions
+// all public methods declared in helper class will be available in $I
+
+class Unit extends \Codeception\Module
+{
+
+}