activemq::util::Usage Class Reference
#include <src/main/activemq/util/Usage.h>
Inheritance diagram for activemq::util::Usage:
Public Member Functions | |
| virtual | ~Usage () |
| virtual void | waitForSpace ()=0 |
| Waits forever for more space to be returned to this Usage Manager. | |
| virtual void | waitForSpace (unsigned int timeout)=0 |
| Waits for more space to be returned to this Usage Manager, times out when the given time span in milliseconds elapses. | |
| virtual void | enqueueUsage (unsigned long long value)=0 |
| Tries to increase the usage by value amount but blocks if this object is currently full. | |
| virtual void | increaseUsage (unsigned long long value)=0 |
| Increases the usage by the value amount. | |
| virtual void | decreaseUsage (unsigned long long value)=0 |
| Decreases the usage by the value amount. | |
| virtual bool | isFull () const =0 |
| Returns true if this Usage instance is full, i.e. | |
Constructor & Destructor Documentation
| virtual activemq::util::Usage::~Usage | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual void activemq::util::Usage::decreaseUsage | ( | unsigned long long | value | ) | [pure virtual] |
Decreases the usage by the value amount.
- Parameters:
-
value Amount of space to return to the pool
Implemented in activemq::util::MemoryUsage.
| virtual void activemq::util::Usage::enqueueUsage | ( | unsigned long long | value | ) | [pure virtual] |
Tries to increase the usage by value amount but blocks if this object is currently full.
- Parameters:
-
value Amount of usage in bytes to add.
Implemented in activemq::util::MemoryUsage.
| virtual void activemq::util::Usage::increaseUsage | ( | unsigned long long | value | ) | [pure virtual] |
Increases the usage by the value amount.
- Parameters:
-
value Amount of usage to add.
Implemented in activemq::util::MemoryUsage.
| virtual bool activemq::util::Usage::isFull | ( | ) | const [pure virtual] |
Returns true if this Usage instance is full, i.e.
Usage >= 100%
- Returns:
- true if Usage is at the Full point.
Implemented in activemq::util::MemoryUsage.
| virtual void activemq::util::Usage::waitForSpace | ( | unsigned int | timeout | ) | [pure virtual] |
Waits for more space to be returned to this Usage Manager, times out when the given time span in milliseconds elapses.
- Parameters:
-
timeout The time to wait for more space.
Implemented in activemq::util::MemoryUsage.
| virtual void activemq::util::Usage::waitForSpace | ( | ) | [pure virtual] |
Waits forever for more space to be returned to this Usage Manager.
Implemented in activemq::util::MemoryUsage.
The documentation for this class was generated from the following file:
- src/main/activemq/util/Usage.h
