Class RingBuffer<E>
- java.lang.Object
-
- de.bsvrz.sys.funclib.losb.ringbuffer.RingBuffer<E>
-
- Type Parameters:
E- Typ der Elemente im Ringpuffer.
- Direct Known Subclasses:
ArchiveRingBuffer
public class RingBuffer<E> extends java.lang.ObjectDer FIFO-Ringpuffer ist über einem Feld von Objektreferenzen angelegt. Die Gesamtkapazität ist festgelegt oder unbegrenzt, wobei das zugrunde liegende Feld stets durch Blöcke fester Größe erweitert oder reduziert wird. Wenn die Gesamtkapazität gleich der Blockgroesse ist, wird das zugrundeliegende Feld nicht veraendert. Die Einfüge- und Ausleseoperationen sind im den Regelfall von konstantem Aufwand und von proportional zur Puffergröße ansteigendem Auf-wand, falls ein neuer Block angefügt oder gelöscht werden muss. Die Einfüge-/Ausleseoperationen des Regelfalles benötigen nur wenige elementare Anweisungen. Es sind keine Speicheroperationen notwendig und es entsteht auch keine Arbeit für den Garbage Collector. Falls die Feldgröße verändert werden muss, kommt der Aufwand für das Kopieren des gesamten Feldes hinzu. Ein Block wird nur dann gelöscht, wenn eine bestimmte Anzahl Blöcke ungenutzt sind. Dadurch werden oszillierende Felder vermieden, wenn der Füllgrad um eine Blockgrenze pendelt. Die Warteschlangen dienen darüber hinaus zur Synchronisation des produzierenden Prozesses (ruft push() auf) und des verarbeitenden Prozesses (ruft pop() auf).
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.Object[]bufprotected intchunkSizeGröße der Blöckeprotected intfirstElemZeiger auf Beginn und Ende des Ringpuffersprotected booleanisEmptyprotected intlastElemZeiger auf Beginn und Ende des Ringpuffersprotected intmaxSizeMaximale Größe der Warteschlangestatic intMIN_CHUNK_SIZEMinimale Blockgroesseprotected intnoOfChunksAnzahl der Blöckestatic intUNBOUNDED_SIZEMinimale Blockgroesse
-
Constructor Summary
Constructors Constructor Description RingBuffer(int chnkSize, int mxSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidadjustSizePostDecr()protected voidadjustSizePreIncr()voidchangeMaxSize(int delta)Aendert doe Maximale Groesse um den angegebenen Wertprotected voidcopy2NewArray(int newSize)EgetLast()Liefert das zuletzt eingefügte Element.booleanisEmpty()protected booleanisFirstElemOneAheadOfLastElem()booleanisFull()Zeigt ob der Buffer vollständig gefüllt ist.intmaxSize()Enext()Liefert den zweitobersten Datensatz zurück.protected intoneStepFurther(int ptr)Epeek()Liefert das erste Element der Warteschlange ohne es zu entfernen.Epop()Liefert das erste Element der Warteschlange.Epop(long timeout)Liefert das erste Element der Warteschlange.EpopNoWait()Liefert das erste Element der Warteschlange odernullwenn keins vorhanden ist.booleanpush(E elem)Fügt ein Objekt in die Warteschlange an letzter Stelle ein.intsize()java.lang.Stringstatus()Informmationsausgabe.E[]toArray(E[] newBuf)Kopiert den Inhalt des Ringpuffers in eine Liste.
-
-
-
Field Detail
-
MIN_CHUNK_SIZE
public static final int MIN_CHUNK_SIZE
Minimale Blockgroesse- See Also:
- Constant Field Values
-
UNBOUNDED_SIZE
public static final int UNBOUNDED_SIZE
Minimale Blockgroesse- See Also:
- Constant Field Values
-
firstElem
protected int firstElem
Zeiger auf Beginn und Ende des Ringpuffers
-
lastElem
protected int lastElem
Zeiger auf Beginn und Ende des Ringpuffers
-
noOfChunks
protected int noOfChunks
Anzahl der Blöcke
-
chunkSize
protected int chunkSize
Größe der Blöcke
-
maxSize
protected int maxSize
Maximale Größe der Warteschlange
-
buf
protected java.lang.Object[] buf
-
isEmpty
protected boolean isEmpty
-
-
Constructor Detail
-
RingBuffer
public RingBuffer(int chnkSize, int mxSize)- Parameters:
chnkSize- Größe der Blöcke, um die das Feld der Warteschlange wächst und schrumpft. Die empfohlene Mindestgröße für diesen Parameter ist16.mxSize- Maximale Groesse der Warteschlange. Wird diese ueberschritten, liefertpush(Object)false. Wenn dieser ParameterUNBOUNDED_SIZEist, ist die Groesse unbegrenzt.
-
-
Method Detail
-
maxSize
public int maxSize()
- Returns:
- Maximale Groesse der Warteschlange oder
UNBOUNDED_SIZE.
-
changeMaxSize
public void changeMaxSize(int delta)
Aendert doe Maximale Groesse um den angegebenen Wert- Parameters:
delta- positiv oder negativ
-
push
public boolean push(E elem)
Fügt ein Objekt in die Warteschlange an letzter Stelle ein. Ein Thread, der in pop() wartet, wird fortgesetzt.- Parameters:
elem- Einzufügendes Objekt- Returns:
- Wahr, wenn Platz in der Queue war und das Datum eingefuegt wurde, falsch sonst
-
pop
public E pop() throws java.lang.InterruptedException
Liefert das erste Element der Warteschlange. Wenn die Warteschlange leer ist, blockiert der aufrufende Thread bis zum nächsten pop()-Aufruf.- Returns:
- Das erste Element der Warteschlange.
- Throws:
java.lang.InterruptedException
-
pop
public E pop(long timeout) throws java.lang.InterruptedException
Liefert das erste Element der Warteschlange. Wenn die Warteschlange leer ist, blockiert der aufrufende Thread oder bricht nach nach einer Wartezeit ab.- Parameters:
timeout- Wartezeit, nach der die Aktion abgebrochen wird.- Returns:
- Das erste Element der Warteschlange oder
null, falls kein Element in der vorgegebenen Zeit engetroffen ist. - Throws:
java.lang.InterruptedException
-
popNoWait
public E popNoWait()
Liefert das erste Element der Warteschlange odernullwenn keins vorhanden ist.- Returns:
- Das erste Element der Warteschlange oder
null
-
peek
public E peek()
Liefert das erste Element der Warteschlange ohne es zu entfernen.- Returns:
- Liefert das erste Element aus der Warteschlange.
nullfalls der Puffer leer ist.
-
getLast
public E getLast()
Liefert das zuletzt eingefügte Element.- Returns:
- Zuletzt eingefügtes Element oder
nullfalls RingBuffer leer.
-
status
public java.lang.String status()
Informmationsausgabe.- Returns:
- Liefert die Anzahl der Blöcke und die Anzahl der Elemente im Puffer zurück.
-
size
public int size()
- Returns:
- Anzahl Elemente im Ringpuffer.
-
isEmpty
public boolean isEmpty()
- Returns:
truefalls sich keine Elemente im Ringpuffer befinden.
-
adjustSizePreIncr
protected void adjustSizePreIncr()
-
adjustSizePostDecr
protected void adjustSizePostDecr()
-
copy2NewArray
protected void copy2NewArray(int newSize)
-
oneStepFurther
protected int oneStepFurther(int ptr)
-
isFirstElemOneAheadOfLastElem
protected boolean isFirstElemOneAheadOfLastElem()
-
isFull
public boolean isFull()
Zeigt ob der Buffer vollständig gefüllt ist.- Returns:
truefalls der Buffer vollständig gefüllt.falsesonst.
-
toArray
public E[] toArray(E[] newBuf)
Kopiert den Inhalt des Ringpuffers in eine Liste. Es werden nur die Referenzen kopiert - d.h. die Liste enthält die gleichen Objekte wie der Ringpuffer.- Parameters:
newBuf- Array in den das Ergebnis kopiert werden soll. Ist das Array zu klein, wird ein neues angelegt.- Returns:
- Liste.
-
next
public E next()
Liefert den zweitobersten Datensatz zurück.- Returns:
- Zeitobersten Datensatz.
nullfalls weniger als zwei Datensätze im Ringpuffer sind.
-
-