MutexSupport (Apache Brooklyn)

java.lang.Object
- brooklyn.util.mutex.MutexSupport

All Implemented Interfaces:: WithMutexes

public class MutexSupport
extends java.lang.Object
implements WithMutexes

Constructor Summary

Constructors
Constructor and Description

MutexSupport()

Constructors
Constructor and Description
`MutexSupport()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acquireMutex(java.lang.String mutexId, java.lang.String description)` acquires a mutex, if available, otherwise blocks on its becoming available; caller must release after use
`void`	`cleanup()`
`void`	`cleanupMutex(java.lang.String mutexId)` forces deletion of the given mutex if it is unused; normally not required as is done automatically on close (but possibly needed where there are cancelations and risk of memory leaks)
`java.util.Map<java.lang.String,SemaphoreWithOwners>`	`getAllSemaphores()` Returns the semaphores in use at the time the method is called, for inspection purposes (and testing).
`boolean`	`hasMutex(java.lang.String mutexId)` returns true if the calling thread has the mutex with the given ID
`void`	`releaseMutex(java.lang.String mutexId)` releases a mutex, triggering another thread to use it or cleaning it up if no one else is waiting; this should only be called by the mutex owner (thread)
`java.lang.String`	`toString()`
`boolean`	`tryAcquireMutex(java.lang.String mutexId, java.lang.String description)` acquires a mutex and returns true, if available; otherwise immediately returns false; caller must release after use if this returns true

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MutexSupport
```
public MutexSupport()
```
- Method Detail
  - cleanupMutex
```
public void cleanupMutex(java.lang.String mutexId)
```
    forces deletion of the given mutex if it is unused; normally not required as is done automatically on close (but possibly needed where there are cancelations and risk of memory leaks)
  - cleanup
```
public void cleanup()
```
  - hasMutex
```
public boolean hasMutex(java.lang.String mutexId)
```
    Description copied from interface: WithMutexes
    
    returns true if the calling thread has the mutex with the given ID
    
    Specified by:
    
    hasMutex in interface WithMutexes
  - acquireMutex
```
public void acquireMutex(java.lang.String mutexId,
                java.lang.String description)
                  throws java.lang.InterruptedException
```
    Description copied from interface: WithMutexes
    
    acquires a mutex, if available, otherwise blocks on its becoming available; caller must release after use
    
    Specified by:
    
    acquireMutex in interface WithMutexes
    
    Throws:
    
    java.lang.InterruptedException
  - tryAcquireMutex
```
public boolean tryAcquireMutex(java.lang.String mutexId,
                      java.lang.String description)
```
    Description copied from interface: WithMutexes
    
    acquires a mutex and returns true, if available; otherwise immediately returns false; caller must release after use if this returns true
    
    Specified by:
    
    tryAcquireMutex in interface WithMutexes
  - releaseMutex
```
public void releaseMutex(java.lang.String mutexId)
```
    Description copied from interface: WithMutexes
    
    releases a mutex, triggering another thread to use it or cleaning it up if no one else is waiting; this should only be called by the mutex owner (thread)
    
    Specified by:
    
    releaseMutex in interface WithMutexes
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getAllSemaphores
```
public java.util.Map<java.lang.String,SemaphoreWithOwners> getAllSemaphores()
```
    Returns the semaphores in use at the time the method is called, for inspection purposes (and testing). The semaphores used by this class may change over time so callers are strongly discouraged from manipulating the semaphore objects themselves.

Class MutexSupport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MutexSupport

Method Detail

cleanupMutex

cleanup

hasMutex

acquireMutex

tryAcquireMutex

releaseMutex

toString

getAllSemaphores