PHP Интерфейс Kraken\Channel\ChannelModelInterface

Наследование: extends Kraken\Event\EventEmitterInterface
Показать файл Открыть проект Примеры использования интерфейса

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

Метод Описание
broadcast ( string[] | string $message ) : bool[] Send broadcast message.
getConnected ( ) : string[] Return array of all connected external channels' IDs.
isConnected ( string $id ) : boolean Check if specific external channel is connected.
isStarted ( ) : boolean Check if channel is started.
isStopped ( ) : boolean Check if channel is stopped.
start ( boolean $blockEvent = false ) : boolean Start Channel.
stop ( boolean $blockEvent = false ) : boolean Stop Channel.
unicast ( string $alias, string[] | string $message, integer $flags ) : boolean Send unicast message.

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

broadcast() публичный метод

Send broadcast message.
public broadcast ( string[] | string $message ) : bool[]
$message string[] | string
Результат bool[]

getConnected() публичный метод

Return array of all connected external channels' IDs.
public getConnected ( ) : string[]
Результат string[]

isConnected() публичный метод

Check if specific external channel is connected.
public isConnected ( string $id ) : boolean
$id string
Результат boolean

isStarted() публичный метод

Check if channel is started.
public isStarted ( ) : boolean
Результат boolean

isStopped() публичный метод

Check if channel is stopped.
public isStopped ( ) : boolean
Результат boolean

start() публичный метод

Start Channel.
public start ( boolean $blockEvent = false ) : boolean
$blockEvent boolean
Результат boolean

stop() публичный метод

Stop Channel.
public stop ( boolean $blockEvent = false ) : boolean
$blockEvent boolean
Результат boolean

unicast() публичный метод

Flags might be one of: Channel::MODE_STANDARD - sends message if both sender and receiver are online. Channel::MODE_BUFFER_OFFLINE - works in similar way as MODE_STANDARD, but also enables buffering messages in case that sender is offline. Channel::MODE_BUFFER_ONLINE - works in similar way as MODE_STANDARD, but also enables buffering messages in case that receiver is offline. Channel::MODE_BUFFER - sends message if both sender and receiver are online or buffers it if one of them is offline.
public unicast ( string $alias, string[] | string $message, integer $flags ) : boolean
$alias string
$message string[] | string
$flags integer
Результат boolean