PHP Класс Gui\Ipc\Sender

This class is used to send communication messages
С версии: 0.1
Автор: Gabriel Couto @gabrielrcouto
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$application gui\Application The application object
$lastId integer The latest id available
$receiver Receiver The receiver object

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

Свойство Тип Описание
$sendLaterMessagesBuffer string The buffer of messages to be sent

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

Метод Описание
__construct ( Application $application, Receiver $receiver ) : void The constructor
send ( MessageInterface $message ) : void Send a message
tick ( ) : void Check and send queued messages
waitReturn ( MessageInterface $message ) : mixed Send a message and wait for the return

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

Метод Описание
getLazarusJson ( MessageInterface $message ) : String Get a valid Lazarus RPC JSON String
out ( String $text ) : void Print debug information
processMessage ( MessageInterface $message ) : void Process a message before sending - Useful to incrementing IDs
writeOnStream ( ) : void Write on stdin stream

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

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

The constructor
public __construct ( Application $application, Receiver $receiver ) : void
$application gui\Application
$receiver Receiver
Результат void

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

Get a valid Lazarus RPC JSON String
protected getLazarusJson ( MessageInterface $message ) : String
$message MessageInterface Message to send
Результат String Lazarus JSON string

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

Print debug information
protected out ( String $text ) : void
$text String Text to print
Результат void

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

Process a message before sending - Useful to incrementing IDs
protected processMessage ( MessageInterface $message ) : void
$message MessageInterface Message
Результат void

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

Send a message
public send ( MessageInterface $message ) : void
$message MessageInterface Message to send
Результат void

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

Check and send queued messages
public tick ( ) : void
Результат void

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

Send a message and wait for the return
public waitReturn ( MessageInterface $message ) : mixed
$message MessageInterface
Результат mixed The return of the message

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

Write on stdin stream
protected writeOnStream ( ) : void
Результат void

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

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

The application object
public Application,Gui $application
Результат gui\Application

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

The latest id available
public int $lastId
Результат integer

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

The receiver object
public Receiver,Gui\Ipc $receiver
Результат Receiver

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

The buffer of messages to be sent
protected string $sendLaterMessagesBuffer
Результат string