Class SynchronizationManagerImpl<T>

java.lang.Object
de.bsvrz.ars.ars.mgmt.datatree.synchronization.SynchronizationManagerImpl<T>
All Implemented Interfaces:
SynchronizationManager<T>

public class SynchronizationManagerImpl<T>
extends java.lang.Object
implements SynchronizationManager<T>
Objekt, das Synchronisierungen auf Elemente vom generischen Typ T verwaltet.

Ein Nutzer dieser Klasse kann entweder Lese- oder Schreibzugriff auf ein Element vom Typ T anfordern und erhält dann ein Schlüssel-Objekt. Nach Abschluss der Operation muss das Schlüsselobjekt freigegeben werden, damit weitere Nutzer auf das Element zugreifen können.

Diese Klasse verwaltet alle vergebenen Schlüssel und erlaubt für Debug-Zwecke z. B. die vergebenen Schlüssel auszugeben.

Der konkrete Typ von T sollte equals und hashCode performant und sinnvoll implementieren.

  • Constructor Summary

    Constructors
    Constructor Description
    SynchronizationManagerImpl​(java.lang.Runnable onOpenAction, java.lang.Runnable onCloseAction)
    Konstruktor.
  • Method Summary

    Modifier and Type Method Description
    SyncKey<T> acquireWriteKey​(T element)
    Fordert exklusiven Zugriff (Schreibzugriff) auf das angegebene Element an.
    SyncKey<T> acquireWriteKey​(T element, java.time.Duration timeout)
    Fordert exklusiven Zugriff (Schreibzugriff) auf das angegebene Element an.
    com.google.common.collect.SetMultimap<T,​SyncKey<T>> getLocks()
    Gibt alle aktuell angeforderten Schlüssel zurück.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • SynchronizationManagerImpl

      public SynchronizationManagerImpl​(java.lang.Runnable onOpenAction, java.lang.Runnable onCloseAction)
      Konstruktor.
      Parameters:
      onOpenAction - Aktion, die ausgeführt wird, wann immer (erstmals) auf ein Element synchronisiert wird.
      onCloseAction - Aktion, die jedes mal ausgeführt wird, wenn ein Thread die Synchronisierung auf ein Element komplett aufgibt, also kein Lock mehr vorhanden ist. Das wird hier benutzt, um alle genutzten Indexe freizugeben.
  • Method Details

    • acquireWriteKey

      public SyncKey<T> acquireWriteKey​(T element) throws SynchronizationFailedException
      Description copied from interface: SynchronizationManager
      Fordert exklusiven Zugriff (Schreibzugriff) auf das angegebene Element an. Ein Schreibzugriff darf nur angefordert werden, wenn dieser Thread noch keinen Lesezugriff besitzt. Ansonsten würde dies Deadlocks verursachen. Sollte dieser Thread bereits einen Schreibzugriff besitzen ist das jedoch kein Problem.
      Specified by:
      acquireWriteKey in interface SynchronizationManager<T>
      Parameters:
      element - Element
      Returns:
      Schlüssel zum Zugriff auf das Element. Solange der Schlüssel gültig ist, garantiert diese Klasse, kann kein anderer Thread einen anderen Schlüssel auf dieses Element hält.
      Throws:
      SynchronizationFailedException - Falls der Schlüssel nicht geholt werden konnte (z. B. interrupted beim warten auf Schlüssel)
    • acquireWriteKey

      public SyncKey<T> acquireWriteKey​(T element, java.time.Duration timeout) throws SynchronizationFailedException
      Description copied from interface: SynchronizationManager
      Fordert exklusiven Zugriff (Schreibzugriff) auf das angegebene Element an. Ein Schreibzugriff darf nur angefordert werden, wenn dieser Thread noch keinen Lesezugriff besitzt. Ansonsten würde dies Deadlocks verursachen. Sollte dieser Thread bereits einen Schreibzugriff besitzen ist das jedoch kein Problem.
      Specified by:
      acquireWriteKey in interface SynchronizationManager<T>
      Parameters:
      element - Element
      timeout - maximale Wartezeit zur synchronisierung
      Returns:
      Schlüssel zum Zugriff auf das Element. Solange der Schlüssel gültig ist, garantiert diese Klasse, kann kein anderer Thread einen anderen Schlüssel auf dieses Element hält.
      Throws:
      SynchronizationFailedException - Falls der Schlüssel nicht geholt werden konnte (z. B. timeout oder interrupted beim warten auf Schlüssel)
    • getLocks

      public com.google.common.collect.SetMultimap<T,​SyncKey<T>> getLocks()
      Description copied from interface: SynchronizationManager
      Gibt alle aktuell angeforderten Schlüssel zurück. Diese Funktion existiert nur zum Debugging bzw. zur Fehleranalyse um z. B. bei Deadlocks den Zustand ausgeben zu können.
      Specified by:
      getLocks in interface SynchronizationManager<T>
      Returns:
      alle aktuell angeforderten Schlüssel
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object