Documentation
MessageSink
Require: IP-Symcon >= 4.1
void MessageSink (int $TimeStamp, int $SenderID, int $MessageID, array $Data)
Parameters
TimeStamp | Continuous counter timestamp |
SenderID | Sender ID |
MessageID | ID of the message |
Data | Data of the message |
Returns
No Return
Description
The content of the function can be overwritten in order to carry out own reactions to certain messages.
The function is only called for registered MessageIDs/SenderIDs combinations.
The time stamp is incremented for every message sent.
RegisterMessage and UnregisterMessage add or remove filter rules.
A list of the MessageIDs can be found here: Messages
If this function is not defined in its own module, the default MessageSink() is executed.
The content of Data can vary depending on the message type. These are not documented yet.
Example
public function MessageSink($TimeStamp, $SenderID, $Message, $Data) {
IPS_LogMessage("MessageSink", "Message from SenderID ".$SenderID." with Message ".$Message."\r\n Data: ".print_r($Data, true));
}