change class name and add comment

kongxinchi · May 14, 2017 · 0bf6885 · 0bf6885
1 parent 717eadc
commit 0bf6885
Show file tree

Hide file tree

Showing 20 changed files with 70 additions and 23 deletions.
diff --git a/example/custom_logger.php b/example/custom_logger.php
@@ -11,11 +11,11 @@ public function log($level, $message, array $context = array())
     }
 }
 
-$manager = new \Jorker\JobForkerManager(3, [
+$forker = new \Jorker\JobForker(3, [
     "logger" => new CustomLogger(),
     'logLevel' => \Psr\Log\LogLevel::DEBUG
 ]);
-$manager->allot(function() {
+$forker->allot(function() {
     for($i = 0; $i < 100; $i++) {
         yield ['i' => $i];
     }

diff --git a/example/custom_report.php b/example/custom_report.php
@@ -1,15 +1,15 @@
 <?php
 require_once(dirname(__DIR__) . '/vendor/autoload.php');
 
-$manager = new \Jorker\JobForkerManager(3, [
+$forker = new \Jorker\JobForker(3, [
     "reportInterval" => 1,                                 // 运行指定秒数后，对运行时统计进行报告
     "reportHandler" => function(\Jorker\MasterStatistics $statistics) {
         $fp = fopen('report.txt', 'a');
         fwrite($fp, date('Y-m-d H:i:s') . "|" . $statistics->formattedInfo() . PHP_EOL);
         fclose($fp);
     }
 ]);
-$manager->allot(function() {
+$forker->allot(function() {
     $result = [];
     for($i = 0; $i < 100; $i++) {
         $result[] = ['i' => $i];

diff --git a/example/failhandler.php b/example/failhandler.php
@@ -1,8 +1,8 @@
 <?php
 require_once(dirname(__DIR__) . '/vendor/autoload.php');
 
-$manager = new \Jorker\JobForkerManager(3);
-$manager->allot(function() {
+$forker = new \Jorker\JobForker(3);
+$forker->allot(function() {
     for($i = 0; $i < 5; $i++) {
         yield ['i' => $i];
     }

diff --git a/example/options.php b/example/options.php
@@ -1,14 +1,14 @@
 <?php
 require_once(dirname(__DIR__) . '/vendor/autoload.php');
 
-$manager = new \Jorker\JobForkerManager(3, [
+$forker = new \Jorker\JobForker(3, [
     "logger" => new \Jorker\Logger\SimpleEchoLogger(),     // 日志接口
     "logLevel" => \Psr\Log\LogLevel::DEBUG,                // 打印日志的最低等级
     "slaveMaxMemory" => 256*1024*1024,                     // 子进程最大内存，超出该内存终止子进程，终止后父进程会重新fork一个新的子进程
     "reportInterval" => 1,                                 // 运行指定秒数后，对运行时统计进行报告
     "stampFilePath" => "/tmp/stamp.dat"                    // 用于记录上一次中断时即将执行的数据
 ]);
-$manager->allot(function() {
+$forker->allot(function() {
     for($i = 1; $i < 100; $i++) {
         yield ['i' => $i];
     }

diff --git a/example/simple.php b/example/simple.php
@@ -1,8 +1,8 @@
 <?php
 require_once(dirname(__DIR__) . '/vendor/autoload.php');
 
-$manager = new \Jorker\JobForkerManager(3);
-$manager->allot(function() {
+$forker = new \Jorker\JobForker(3);
+$forker->allot(function() {
     $jobs = [];
     for($i = 0; $i < 100; $i++) {
         $jobs[] = ['i' => $i];

diff --git a/example/stopandcontinue.php b/example/stopandcontinue.php
@@ -6,8 +6,8 @@
  * next time you run this script, the arg $start will be the first not execute job
  */
 
-$manager = new \Jorker\JobForkerManager(1);
-$manager->allot(function($start) {
+$forker = new \Jorker\JobForker(1);
+$forker->allot(function($start) {
     $i = is_null($start) ? 0 : $start['i'];
     for(; $i < 100; $i++) {
         usleep(100000);

diff --git a/example/yield.php b/example/yield.php
@@ -1,8 +1,8 @@
 <?php
 require_once(dirname(__DIR__) . '/vendor/autoload.php');
 
-$manager = new \Jorker\JobForkerManager(3);
-$manager->allot(function() {
+$forker = new \Jorker\JobForker(3);
+$forker->allot(function() {
     for($i = 0; $i < 100; $i++) {
         yield ['i' => $i];
     }

diff --git a/src/JobForkerManager.php → src/JobForker.php b/src/JobForkerManager.php → src/JobForker.php
@@ -9,10 +9,10 @@
 
 /**
  * 多进程任务执行
- * Class JobForkerManager
- * @package Gaia\Helpers\JobForker
+ * Class class JobForker
+ * @package Jorker
  */
-class JobForkerManager
+class JobForker
 {
     /**
      * 日志接口

diff --git a/src/Logger/LoggerWrapper.php b/src/Logger/LoggerWrapper.php
@@ -4,6 +4,11 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 
+/**
+ * 日志接口包装，使调用者可以限制输出的日志等级
+ * Class LoggerWrapper
+ * @package Jorker\Logger
+ */
 class LoggerWrapper implements LoggerInterface
 {
 

diff --git a/src/Logger/SimpleEchoLogger.php b/src/Logger/SimpleEchoLogger.php
@@ -4,9 +4,9 @@
 use Psr\Log\AbstractLogger;
 
 /**
- * 将日志输出到屏幕
+ * 默认的日志接口实现，将日志简单的输出到屏幕
  * Class SimpleEchoLogger
- * @package Gaia\Helpers\JobForker
+ * @package Jorker\Logger
  */
 class SimpleEchoLogger extends AbstractLogger
 {

diff --git a/src/MasterStatistics.php b/src/MasterStatistics.php
@@ -3,6 +3,11 @@
 
 use Jorker\Slave\SlaveResponse;
 
+/**
+ * 父进程中统计脚本执行情况
+ * Class MasterStatistics
+ * @package Jorker
+ */
 class MasterStatistics
 {
     /**

diff --git a/src/Slave/Error/SlaveError.php b/src/Slave/Error/SlaveError.php
@@ -1,6 +1,11 @@
 <?php
 namespace Jorker\Slave\Error;
 
+/**
+ * 子进程响应回传时，对于造成进程崩溃的错误的封装
+ * Class SlaveError
+ * @package Jorker\Slave\Error
+ */
 class SlaveError implements SlaveErrorInterface
 {
     /**

diff --git a/src/Slave/Error/SlaveErrorInterface.php b/src/Slave/Error/SlaveErrorInterface.php
@@ -1,7 +1,11 @@
 <?php
 namespace Jorker\Slave\Error;
 
-
+/**
+ * 子进程错误封装接口
+ * Interface SlaveErrorInterface
+ * @package Jorker\Slave\Error
+ */
 interface SlaveErrorInterface
 {
     /**

diff --git a/src/Slave/Error/SlaveException.php b/src/Slave/Error/SlaveException.php
@@ -1,6 +1,11 @@
 <?php
 namespace Jorker\Slave\Error;
 
+/**
+ * 子进程响应回传时，对于执行异常的封装
+ * Class SlaveException
+ * @package Jorker\Slave\Error
+ */
 class SlaveException implements SlaveErrorInterface
 {
     protected $className;

diff --git a/src/Slave/Slave.php b/src/Slave/Slave.php
@@ -4,6 +4,11 @@
 use Jorker\SocketCommunicate;
 use Psr\Log\LoggerInterface;
 
+/**
+ * 子进程类，任务轮训
+ * Class Slave
+ * @package Jorker\Slave
+ */
 class Slave
 {
     /**

diff --git a/src/Slave/SlaveInfo.php b/src/Slave/SlaveInfo.php
@@ -1,7 +1,11 @@
 <?php
 namespace Jorker\Slave;
 
-
+/**
+ * 子进程运行状态
+ * Class SlaveInfo
+ * @package Jorker\Slave
+ */
 class SlaveInfo
 {
     /**

diff --git a/src/Slave/SlaveKeeper.php b/src/Slave/SlaveKeeper.php
@@ -9,7 +9,7 @@
 /**
  * 主进程对子进程状态的维护，对象在主进程中
  * Class SlaveKeeper
- * @package Gaia\Helpers\JobForker
+ * @package Jorker\Slave
  */
 class SlaveKeeper
 {

diff --git a/src/Slave/SlaveRequest.php b/src/Slave/SlaveRequest.php
@@ -1,6 +1,11 @@
 <?php
 namespace Jorker\Slave;
 
+/**
+ * 父进程任务分发请求
+ * Class SlaveRequest
+ * @package Jorker\Slave
+ */
 class SlaveRequest
 {
     const TYPE_RUN = 'run';

diff --git a/src/Slave/SlaveResponse.php b/src/Slave/SlaveResponse.php
@@ -5,6 +5,11 @@
 use Jorker\Slave\Error\SlaveErrorInterface;
 use Jorker\Slave\Error\SlaveException;
 
+/**
+ * 子进程响应回传
+ * Class SlaveResponse
+ * @package Jorker\Slave
+ */
 class SlaveResponse
 {
     /**

diff --git a/src/SocketCommunicate.php b/src/SocketCommunicate.php
@@ -1,7 +1,11 @@
 <?php
-
 namespace Jorker;
 
+/**
+ * 主进程与进程通信
+ * Class SocketCommunicate
+ * @package Jorker
+ */
 class SocketCommunicate
 {
     public static function send($handler, $data)