\PG\MSFServer

Class Server

Summary

Methods

Properties

Constants

setContext()
destroy()
__construct()
getTimerContext()
getInstance()
setConfig()
run()
setProcessTitle()
setServerSet()
beforeSwooleStart()
onStart()
onWorkerStart()
onClose()
onWorkerStop()
onTask()
onFinish()
onPipeMessage()
onWorkerError()
onManagerStart()
onManagerStop()
__call()
registerTimer()
displayErrorHandler()
checkErrors()
isTaskWorker()
close()
onErrorHandle()

$processType
$daemonize
$pidFile
$scheduler
$name
$user
$workerNum
$taskNum
$tickTime
$pack
$onErrorHandle
$server
$config
$log
$sysCache
$sysTimers
$MSFSrcDir
$objectPool

version
mode

init()
parseCommand()
initWorkers()
getCurrentUser()
displayUI()
startSwooles()

$reflections
$instance
$_masterPid
$logFile
$_startFile
$_worker
$route
$stdClass

N/A

No private methods found

No private properties found

N/A

abstract

File: Server.php
Package: PG\MSF
Class hierarchy: \PG\MSF\Base\Child

\PG\MSF\Server

Constants

version

version

版本

mode

mode

运行方式（web/console）

Properties

$processType

$processType : integer

Type

integer — 进程类型，worker,tasker,user

$daemonize

$daemonize : boolean

Type

boolean — Daemonize.

$pidFile

$pidFile : string

Type

string — pid文件

$scheduler

$scheduler : \PG\MSF\Coroutine\Scheduler

Type

\PG\MSF\Coroutine\Scheduler — 协程调度器

$name

$name : string

Type

string — server name

$user

$user : string

Type

string — server user

$workerNum

$workerNum : integer

Type

integer — Worker数量

$taskNum

$taskNum : integer

Type

integer — Tasker数量

$tickTime

$tickTime : integer

Type

integer — 服务器到现在的毫秒数

$pack

$pack : \PG\MSF\Pack\IPack

Type

\PG\MSF\Pack\IPack — 数据打包与解包

$onErrorHandle

$onErrorHandle : callback

Type

callback — 错误回调

$server

$server : \swoole_server

Type

\swoole_server — Server运行实例

$config

$config : \Noodlehaus\Config

Type

\Noodlehaus\Config — 配置对象

$log

$log : \PG\Log\PGLog

Type

\PG\Log\PGLog — 日志对象

$sysCache

$sysCache : \Yac

Type

\Yac — 系统共享对象操作句柄

$sysTimers

$sysTimers : array

系统注册的定时器列表

Type

array

$MSFSrcDir

$MSFSrcDir : string

Type

string — 框架目录

$objectPool

$objectPool : \PG\MSF\Base\Pool

Type

\PG\MSF\Base\Pool — 对象池

$reflections

$reflections : array

Type

array — 反射类属性的默认值

$instance

$instance : \PG\MSF\Server

Type

\PG\MSF\Server — 实例

$_masterPid

$_masterPid : integer

Type

integer — Master进程ID

$logFile

$logFile : mixed

Type

mixed — 日志文件

$_startFile

$_startFile : string

Type

string — Start file.

$_worker

$_worker : \PG\MSF\Server

Type

\PG\MSF\Server — worker instance.

$route

$route : \PG\MSF\Route\IRoute|\PG\MSF\Route\NormalRoute

Type

\PG\MSF\Route\IRoute|\PG\MSF\Route\NormalRoute — 路由器

$stdClass

$stdClass : \stdClass|null

Type

\stdClass|null — 对象模板

Methods

setContext()

setContext(\PG\MSF\Helpers\Context  $context) : $this

设置上下文

Parameters

\PG\MSF\Helpers\Context

$context

请求上下文对象

Returns

$this

destroy()

destroy()

销毁,解除引用

__construct()

__construct()

Server constructor.

Throws

\Exception

getTimerContext()

getTimerContext() : NULL|\PG\MSF\Helpers\Context

创建用户自定义定时进程的上下文对象

Returns

NULL|\PG\MSF\Helpers\Context

getInstance()

getInstance() : \PG\MSF\Server|\PG\MSF\MSFServer

获取运行的Server实例

Returns

\PG\MSF\Server|\PG\MSF\MSFServer

setConfig()

setConfig() : mixed

配置初始化

Returns

mixed

run()

run() : void

运行所有的服务进程

setProcessTitle()

setProcessTitle(string  $title) : void

设置服务进程名称

Parameters

string

$title

setServerSet()

setServerSet() : mixed

设置服务器配置参数

Returns

mixed

beforeSwooleStart()

beforeSwooleStart()

start前的操作

onStart()

onStart(  $serv)

Server启动在主进程的主线程回调此函数

Parameters

$serv

onWorkerStart()

onWorkerStart(\swoole_server  $serv, integer  $workerId)

worker进程/task进程启动回调

Parameters

\swoole_server	$serv	server实例
integer	$workerId	worker id

onClose()

onClose(  $serv,   $fd)

TCP客户端连接关闭后，在worker进程中回调此函数

Parameters

	$serv
	$fd

onWorkerStop()

onWorkerStop(  $serv,   $fd)

此事件在worker进程终止时发生

Parameters

	$serv
	$fd

onTask()

onTask(  $serv,   $taskId,   $fromId,   $data) : mixed

在task_worker进程内被调用

Parameters

	$serv
	$taskId
	$fromId
	$data

Returns

mixed

onFinish()

onFinish(  $serv,   $taskId,   $data)

当worker进程投递的任务在task_worker中完成时调用

Parameters

	$serv
	$taskId
	$data

onPipeMessage()

onPipeMessage(  $serv,   $fromWorkerId,   $message)

当工作进程收到由sendMessage发送的管道消息时会触发onPipeMessage事件

Parameters

	$serv
	$fromWorkerId
	$message

onWorkerError()

onWorkerError(\swoole_server  $serv, integer  $workerId, integer  $workerPid, integer  $exitCode)

当worker/task_worker进程发生异常后会在Manager进程内回调此函数。

Parameters

\swoole_server	$serv	server实例
integer	$workerId	worker id
integer	$workerPid	worker pid
integer	$exitCode	退出状态码

onManagerStart()

onManagerStart(  $serv)

当管理进程启动时调用

Parameters

$serv

onManagerStop()

onManagerStop(  $serv)

当管理进程结束时调

Parameters

$serv

__call()

__call(  $name,   $arguments) : mixed

__call魔术方法

Parameters

	$name
	$arguments

Returns

mixed

registerTimer()

registerTimer(integer  $ms, callable  $callBack, array  $params = array())

定时器包装（用于业务Timer进程）

Parameters

integer	$ms	定时器间隔毫秒
callable	$callBack	定时器执行的回调
array	$params	定时器其他参数

displayErrorHandler()

displayErrorHandler(integer  $error, string  $errorString, string  $filename, integer  $line, array  $symbols)

全局错误监听

Parameters

integer	$error	错误码
string	$errorString	错误描述
string	$filename	文件名
integer	$line	文件行
array	$symbols	符号表

checkErrors()

checkErrors() : void

致命错误回调

isTaskWorker()

isTaskWorker() : boolean

是否是task进程

Returns

boolean

close()

close(integer  $fd)

服务器主动关闭链接

Parameters

integer

$fd

onErrorHandle()

onErrorHandle(  $msg,   $log)

错误处理函数

Parameters

	$msg
	$log

init()

init() : void

服务初始化

parseCommand()

parseCommand() : void

解析命令行参数

initWorkers()

initWorkers() : void

初始化worker进程

getCurrentUser()

getCurrentUser() : string

获取当前进程用户

Returns

string

displayUI()

displayUI() : void

显示命令行控制台信息

startSwooles()

startSwooles() : void

Fork some worker processes.