An open API service indexing awesome lists of open source software.

https://github.com/slince/process

:whale2: The process wrapper and manager based on PCNTL on the Unix-like systems using php
https://github.com/slince/process

child-process fifo fork pcntl pipe posix process semaphore shared-memory system-v

Last synced: 9 months ago
JSON representation

:whale2: The process wrapper and manager based on PCNTL on the Unix-like systems using php

Awesome Lists containing this project

README

          

# Process Library

[![Build Status](https://img.shields.io/github/actions/workflow/status/slince/process/test.yml?style=flat-square)](https://github.com/slince/process/actions)
[![Coverage Status](https://img.shields.io/codecov/c/github/slince/process.svg?style=flat-square)](https://codecov.io/github/slince/process)
[![Total Downloads](https://img.shields.io/packagist/dt/slince/process.svg?style=flat-square)](https://packagist.org/packages/slince/process)
[![Latest Stable Version](https://img.shields.io/packagist/v/slince/process.svg?style=flat-square&label=stable)](https://packagist.org/packages/slince/process)
[![Scrutinizer](https://img.shields.io/scrutinizer/g/slince/process.svg?style=flat-square)](https://scrutinizer-ci.com/g/slince/process/?branch=master)

The library help to work with processes. It provides a more readable api and various modes for IPC via pipe(FIFO) and system v.

# Installation

Install via composer

```bash
composer require slince/process
```

# Dependencies

The library replies on the following php's extension.

- ext-pcntl. Provides control processes (MUST)
- ext-sysvshm. Porvides system v shared memory (OPTIONAL)
- ext-sysvsem. Porvides system v semaphore (OPTIONAL)
- ext-sysmsg. Porvides system v message queue (OPTIONAL)

# Usage

## Basic usage

```php
$process = new Slince\Process\Process(function(){
echo 'hello, my pid is ' . getmypid();
});
$process->start();

var_dump($process->isRunning()); // echo true
var_dump($process->getPid()); // will output the pid of child process
//do something other

$process->wait(); //waiting for the process to exit
```

## Sends signal to the process

>Note: If your php version is less than 7.1, please add the statement `declare(ticks=1);` at the beginning of the file:

```php
$process = new Slince\Process\Process(function(){
Slince\Process\Process::current()->signal([SIGUSR1, SIGUSR2], function(){
echo 'trigger signal';
});
echo 'hello, my pid is ' . getmypid();
});
$process->start();
$process->signal(SIGUSER1);
//do something
$process->wait();
```

## Shared memory

```php
$memory = new Slince\Process\SystemV\SharedMemory();
$memory->set('foo', 'bar');
var_dump($memory->get('foo'));
```
The default size of shared memory is the sysvshm.init_mem in the php.ini, otherwise 10000 bytes. You can adjust this.

```php
$memory = new Slince\Process\SystemV\SharedMemory(__FILE__, '5M'); //Adjusts to 5m
```

## Semaphore
```php
$semaphore = new Slince\Process\SystemV\Semaphore();
$semaphore->acquire(); //Acquires a lock
// do something
$semaphore->release() //Releases a lock
```

## Message queue

```php
$queue = new Slince\Process\SystemV\MessageQueue();
$queue->send('hello');
echo $queue->receive(); //Will output hello
```

## Fifo

```php
$writeFifo = new Slince\Process\Pipe\WritableFifo('/tmp/test.pipe');
$writeFifo->write('some message');
$readFifo = new Slince\Process\Pipe\ReadableFifo('/tmp/test.pipe');
echo $readFifo->read();
```

## License

The MIT license. See [MIT](https://opensource.org/licenses/MIT)