Dokumentation
IPS_GetSnapshotRingBufferStats
array IPS_GetSnapshotRingBufferStats ()
Rückgabewert
Ein Array mit folgenden key => value Paaren:
| Index | Typ | Beschreibung |
|---|---|---|
| Count | integer | Anzahl der Nachrichten im Ringpuffer |
| TotalBytes | integer | Geschätzter Speicherbedarf des Ringpuffers inklusive der Nachrichten in Bytes |
Beschreibung
Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.
Die Funktion liefert die Größe des Nachrichten-Ringpuffers. Darin hält IP-Symcon die zuletzt versendeten Nachrichten vor, damit Clients wie die Konsole nach einem Snapshot nur die seitdem aufgetretenen Änderungen abrufen müssen. Die Größe des Ringpuffers wird über den Spezialschalter "MessageRingBufferSize" festgelegt (Standard: 8192 Nachrichten). Ist der Ringpuffer voll, werden die ältesten Nachrichten überschrieben, Count erreicht also höchstens diesen Wert.
Die Bytes sind eine Schätzung des belegten Arbeitsspeichers anhand der gespeicherten Datenstrukturen und keine exakte Messung. Der Wert wird auch in der Reihe "SnapshotRingBuffer" von IPS_GetStatsHistory aufgezeichnet.
Beispiel
// Größe des Nachrichten-Ringpuffers ausgeben
print_r(IPS_GetSnapshotRingBufferStats());
/* liefert z.B.:
Array
(
[Count] => 8192
[TotalBytes] => 3145728
)
*/