ringbuffer.c-Dateireferenz

Implmentiert einen Ringbuffer in LPC. Mehr ...

#include <util/ringbuffer.h>

Include-Abhängigkeitsdiagramm für ringbuffer.c:

gehe zum Quellcode dieser Datei

Klassen
struct	std_ringbuffer
	Struktur, die einen Ringpuffer speichert. Mehr ...
Makrodefinitionen
#define	MAXCOUNT   30
	Standardgroesse fuer Ringbuffer.
Funktionen
protected struct std_ringbuffer	CreateRingBuffer (int size, int newmode)
	Erzeugt einen neuen Ringbuffer und liefert ihn zurueck.
protected void	RingBufferPut (struct std_ringbuffer buffer, mixed val)
	Schreibt einen neuen Wert in den Ringbuffer.
protected mixed	RingBufferGet (struct std_ringbuffer buffer)
	Liefert ein Array mit allen Werten des Ringbuffers buffer.
protected struct std_ringbuffer	ResizeRingBuffer (struct std_ringbuffer buf, int size)
	Erzeugt einen neuen Ringbuffer der Groesse size und dem gleichen Modus wie buf, der dieselben Daten enthaelt wie buf.

---

Ausführliche Beschreibung

Implmentiert einen Ringbuffer in LPC.

Ab und an hat man den Fall, dass man Ereignisse/Meldungen o.ae. hat, von denen man immer genau die letzten x gespeichert und abrufbar vorhalten moechte. Dieses File stellt eine Datenstruktur und dazugehoerige Verwaltungsfunktionen zu Verfuegung, mit denen dies effizient moeglich ist. Insbesondere umgehen diese das staendige Slicing von Arrays, mit denen haeufig Ringpuffer gebaut werden. Hierbei wird das Schreiben in den Puffer billiger, das Abrufen der Daten allerdings teurer. Wird der Puffer haeufiger abgefragt als beschrieben, ist dies keine effiziente Loesung.

Autor:

Zesstra

Datum:

22.05.2008

Version:

$Id$

Definiert in Datei ringbuffer.c.

---

Makro-Dokumentation

#define MAXCOUNT   30

Standardgroesse fuer Ringbuffer.

Definiert in Zeile 31 der Datei ringbuffer.c.

Wird benutzt von CreateRingBuffer().

---

Dokumentation der Funktionen

protected struct std_ringbuffer CreateRingBuffer	(	int	size,
		int	newmode
	)			[read]

Erzeugt einen neuen Ringbuffer und liefert ihn zurueck.

Die Funktion erzeugt einen neuen, leeren Ringbuffer der Groesse size und mit Ausgabemodus newmode und liefert die entsprechende Ringbuffer-Struktur zurueck.

Achtung:

Die zurueckgelieferte Datenstruktur bitte nicht per Hand manipulieren.

Parameter:

[in]	size	Groesse des zu erzeugenden Ringbuffers. Default: 30
[in]	newmode	Ausgabemodus des Ringbuffers: MODE_FIFO oder MODE_LIFO. Default: MODE_FIFO

Rückgabe:

Der erzeugte Ringbuffer (struct vom Typ std_ringbuffer).

Siehe auch:

ResizeRingBuffer, RingBufferPut, RingBufferGet

Definiert in Zeile 59 der Datei ringbuffer.c.

Benutzt MAXCOUNT, std_ringbuffer::mode, MODE_FIFO, MODE_LIFO, std_ringbuffer::next und std_ringbuffer::rbuffer.

Wird benutzt von ResizeRingBuffer().

                                                                        {
  
  struct std_ringbuffer buffer = (<std_ringbuffer>
       rbuffer: allocate(size||MAXCOUNT, 0), 
       mode: newmode || MODE_FIFO, 
       next: 0 );

  // Bei LIFO von oben anfangen.
  if (newmode==MODE_LIFO)
    buffer->next = sizeof(buffer->rbuffer);
  
  return buffer;
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

protected struct std_ringbuffer ResizeRingBuffer	(	struct std_ringbuffer	buf,
		int	size
	)			[read]

Erzeugt einen neuen Ringbuffer der Groesse size und dem gleichen Modus wie buf, der dieselben Daten enthaelt wie buf.

Diese Funktion erzeugt einen neuen Ringbuffer und kopiert alle Daten aus dem alten Puffer in den neuen um.

Parameter:

[in]	buf	alter Ringbuffer
[in]	size	gewuenschte neue Groesse

Rückgabe:

Liefert neuen Ringbuffer mit gewuenschten Groesse.

Siehe auch:

CreateRingBuffer, RingBufferPut, RingBufferGet

Achtung:

Wird der Ringbuffer verkleinert, kommt es zum Verlust der aeltesten Daten, die nicht mehr in den neuen hineinpassen.

Noch zu erledigen:

Effizientere Implementation.

Definiert in Zeile 154 der Datei ringbuffer.c.

Benutzt buf, CreateRingBuffer(), RingBufferGet() und RingBufferPut().

                                                           {
  // neuen Ringbuffer anlegen.
  struct std_ringbuffer nbuf = CreateRingBuffer(size, buf->mode);
  // und alle daten aus dem alten wieder reinstopfen.
  // ja, das geht effizienter, hab ich gerade aber keinen Bock drauf. Die
  // Funktion wird vermutlich eh sehr selten gerufen.
  foreach(mixed val: RingBufferGet(buf))
    RingBufferPut(nbuf, val);
  // neuen Buffer zurueckgeben. Der alte bleibt unveraendert!
  return nbuf;
}

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

protected mixed RingBufferGet

(

struct std_ringbuffer

buffer

)

Liefert ein Array mit allen Werten des Ringbuffers buffer.

Das zurueckgelieferte Array enthaelt alle Daten des Ringbuffers in der beim Erstellen des Puffers gewuenschten Reihenfolge (s. MODE_FIFO, MODE_LIFO). Ist der Puffer noch nicht vollstaendig gefuellt, enthalten die bisher noch nie beschriebenen Elemente 0.

Parameter:

[in]

buffer

Ringpuffer, dessen Daten ausgeben werden sollen.

Rückgabe:

Array mit Daten des Puffers.

Siehe auch:

CreateRingBuffer, RingBufferPut, ResizeRingBuffer

Definiert in Zeile 115 der Datei ringbuffer.c.

Benutzt std_ringbuffer::mode, MODE_LIFO, std_ringbuffer::next und std_ringbuffer::rbuffer.

Wird benutzt von ResizeRingBuffer().

                                                            {
  int size = sizeof(buffer->rbuffer);
  int next = buffer->next;
  mixed rbuffer = buffer->rbuffer;

  switch(buffer->mode) {
    case MODE_LIFO:
      // der hintere Teil enthaelt die neueren Daten. Die kommen zuerst.
      // Wenn next == sizeof(), dann kann das interne Array einfach kopiert
      // werden.
      if (next == size)
                return copy(rbuffer);
      else
                return rbuffer[next .. size-1] + rbuffer[0 .. next-1];
    default:
      // der vordere Teil enthaelt die neueren Daten. Also zuerst den hinteren
      // ausgeben, dann den vorderen.
      // Wenn next 0, kann das interne Array einfach kopiert werden. Sonst
      // muss es zusammengesetzt werden.
      if (next)
                return rbuffer[next .. size-1] + rbuffer[0 .. next-1];
      else
                return copy(rbuffer);
  }
  return 0;
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

protected void RingBufferPut	(	struct std_ringbuffer	buffer,
		mixed	val
	)

Schreibt einen neuen Wert in den Ringbuffer.

Diese Funktion schreibt einen neuen Wert in den Ringbuffer buffer und loescht dabei ggf. den aeltesten Wert im Puffer.

Parameter:

[in,out]	buffer	zu aendernder Ringbuffer
[in]	val	hinzuzufuegender Wert

Siehe auch:

CreateRingBuffer, ResizeRingBuffer, RingBufferGet

Definiert in Zeile 80 der Datei ringbuffer.c.

Benutzt std_ringbuffer::mode, MODE_LIFO, std_ringbuffer::next und std_ringbuffer::rbuffer.

Wird benutzt von ResizeRingBuffer().

                                                                      {
  int next = buffer->next;
  // je nach Ausgabemodus von oben nach unten oder von unten nach oben die
  // Werte reinschreiben.
  switch(buffer->mode) {
    case MODE_LIFO:
      // next ist hier eigentlich ein 'last'. Dekrementieren und dann zum
      // Indizieren benutzen.
      buffer->rbuffer[--next] = val;
      // wenn man gerade in Element 0 geschrieben hat, ist naechstes Element
      // sizeof()-1, d.h. sizeof() als next vermerken.
      next ||= sizeof(buffer->rbuffer);
      break;
    default:
      // Wert schreiben und next inkrementieren.
      buffer->rbuffer[next++] = val;
      // wird sizeof() erreicht, ist das naechste Element 0. Etwas schneller
      // waere ein Modulo mit der Buffergroesse direkt bei der Indizierung
      // oben, aber dann kann es u.U. durch einen numerischen Overflow buggen.
      if (next==sizeof(buffer->rbuffer))
                next = 0;
  }
  buffer->next = next;
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird: