PHP Класс PHPDaemon\Network\Pool

Автор: Vasily Zorin ([email protected])
Наследование: extends PHPDaemon\Structures\ObjectStorage, use trait PHPDaemon\Traits\EventLoopContainer
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$appInstance Application instance object
$config Configuration
$connectionClass Default connection class
$maxAllowedPacket Max allowed packet
$maxConcurrency Max concurrency
$name Name

Защищенные свойства (Protected)

Свойство Тип Описание
$enabled Is enabled?
$finished Is finished?
$instances Instances storage
$overload Is overloaded?

Открытые методы

Метод Описание
__construct ( array $config = [], boolean $init = true ) Constructor
attach ( object $conn, mixed $inf = null ) : void Attach Connection
connect ( string $url, callback $cb, string $class = null ) : integer Establish a connection with remote peer
detach ( object $conn ) : void Detach Connection
disable ( ) : void Disable all events of sockets
enable ( ) : void Enable socket events
finish ( $graceful = false ) : boolean Finishes ConnectionPool
getInstance ( string $arg = '', boolean $spawn = true ) : this Returns instance object
onConfigUpdated ( ) : void Called when worker is going to update configuration
onReady ( ) : void Called when the worker is ready to go
onShutdown ( boolean $graceful = false ) : boolean Called when application instance is going to shutdown
setConnectionClass ( string $class ) : void Sets default connection class

Защищенные методы

Метод Описание
applyConfig ( ) : void Applies config
getConfigDefaults ( ) : boolean Setting default config options
init ( ) : void Init
onDisable ( ) : void Called when ConnectionPool is now disabled
onEnable ( ) : void Called when ConnectionPool is now enabled
onFinish ( ) : void Called when ConnectionPool is finished

Описание методов

__construct() публичный Метод

Constructor
public __construct ( array $config = [], boolean $init = true )
$config array Config variables
$init boolean

applyConfig() защищенный Метод

Applies config
protected applyConfig ( ) : void
Результат void

attach() публичный Метод

Attach Connection
public attach ( object $conn, mixed $inf = null ) : void
$conn object Connection
$inf mixed Info
Результат void

connect() публичный Метод

Establish a connection with remote peer
public connect ( string $url, callback $cb, string $class = null ) : integer
$url string URL
$cb callback Callback
$class string Optional. Connection class name
Результат integer Connection's ID. Boolean false when failed

detach() публичный Метод

Detach Connection
public detach ( object $conn ) : void
$conn object Connection
Результат void

disable() публичный Метод

Disable all events of sockets
public disable ( ) : void
Результат void

enable() публичный Метод

Enable socket events
public enable ( ) : void
Результат void

finish() публичный Метод

Finishes ConnectionPool
public finish ( $graceful = false ) : boolean
Результат boolean Success

getConfigDefaults() защищенный Метод

Setting default config options
protected getConfigDefaults ( ) : boolean
Результат boolean

getInstance() публичный статический Метод

Returns instance object
public static getInstance ( string $arg = '', boolean $spawn = true ) : this
$arg string name / array config / ConfigSection
$spawn boolean Spawn? Default is true
Результат this

init() защищенный Метод

Init
protected init ( ) : void
Результат void

onConfigUpdated() публичный Метод

Called when worker is going to update configuration
public onConfigUpdated ( ) : void
Результат void

onDisable() защищенный Метод

Called when ConnectionPool is now disabled
protected onDisable ( ) : void
Результат void

onEnable() защищенный Метод

Called when ConnectionPool is now enabled
protected onEnable ( ) : void
Результат void

onFinish() защищенный Метод

Called when ConnectionPool is finished
protected onFinish ( ) : void
Результат void

onReady() публичный Метод

Called when the worker is ready to go
public onReady ( ) : void
Результат void

onShutdown() публичный Метод

Called when application instance is going to shutdown
public onShutdown ( boolean $graceful = false ) : boolean
$graceful boolean
Результат boolean Ready to shutdown?

setConnectionClass() публичный Метод

Sets default connection class
public setConnectionClass ( string $class ) : void
$class string Connection class name
Результат void

Описание свойств

$appInstance публичное свойство

Application instance object
public $appInstance

$config публичное свойство

Configuration
public $config

$connectionClass публичное свойство

Default connection class
public $connectionClass

$enabled защищенное свойство

Is enabled?
protected $enabled

$finished защищенное свойство

Is finished?
protected $finished

$instances защищенное статическое свойство

Instances storage
protected static $instances

$maxAllowedPacket публичное свойство

Max allowed packet
public $maxAllowedPacket

$maxConcurrency публичное свойство

Max concurrency
public $maxConcurrency

$name публичное свойство

Name
public $name

$overload защищенное свойство

Is overloaded?
protected $overload