Версия: 6.x
burger close
Класс LongPolling

Подробное описание

Класс, обеспечивающий работу очереди событий, мгновенно доставляемой авторизованному администратору.

Открытые члены

 enable ()
 
 disable ()
 
 isEnable ()
 
 pushEvent ($event_name, $data, $user_id, $expire)
 
 removeEvents ($event_name, $data=null, $user_id=null)
 
 removeExpireEvents ()
 

Открытые статические члены

static getInstance ()
 

Защищенные члены

 __construct ()
 

Статические защищенные данные

static $instance
 

Конструктор(ы)

__construct ( )
protected

SingleTon. Использовать LongPolling::getInstance() вместо конструктора

Методы

disable ( )

Отключает long polling для администратора на сайте

Возвращает
void
enable ( )

Включает Long polling для администратора на сайте

Возвращает
void
static getInstance ( )
static

Возвращает общий экземпляр текущего класса

Возвращает
LongPolling
isEnable ( )

Возвращает true, если включен режим long polling

Возвращает
bool
pushEvent (   $event_name,
  $data,
  $user_id,
  $expire 
)

Добавляет событие в стек для отдачи пользователю. Сообщение будет передано при следующем запросе пользователя

Аргументы
string$event_name
mixed$dataданные
integer$user_idID пользователя
integer$expire- время истечения актуальности события, в секундах
Возвращает
LongPollingEvent
removeEvents (   $event_name,
  $data = null,
  $user_id = null 
)

Удаляет событие из стека

Аргументы
$event
$data
$user_id
null$expire
Возвращает
int
Исключения
\RS\Db\Exception
\RS\Exception
removeExpireEvents ( )

Удаляет все события, потерявшие актуальность

Возвращает
integer возвращает количество удаленных событий

Поля

$instance
staticprotected