activemq-cpp-3.9.0
decaf::util::concurrent::Delayed Class Referenceabstract

A mix-in style interface for marking objects that should be acted upon after a given delay. More...

#include <src/main/decaf/util/concurrent/Delayed.h>

Inheritance diagram for decaf::util::concurrent::Delayed:

Public Member Functions

virtual ~Delayed ()
 
virtual long long getDelay (const TimeUnit &unit)=0
 Returns the remaining delay associated with this object, in the given time unit. More...
 
- Public Member Functions inherited from decaf::lang::Comparable< Delayed >
virtual ~Comparable ()
 
virtual int compareTo (const Delayed &value) const =0
 Compares this object with the specified object for order. More...
 
virtual bool equals (const Delayed &value) const =0
 
virtual bool operator== (const Delayed &value) const =0
 Compares equality between this object and the one passed. More...
 
virtual bool operator< (const Delayed &value) const =0
 Compares this object to another and returns true if this object is considered to be less than the one passed. More...
 

Detailed Description

A mix-in style interface for marking objects that should be acted upon after a given delay.

An implementation of this interface must define a Comparable methods that provides an ordering consistent with its getDelay method.

Constructor & Destructor Documentation

virtual decaf::util::concurrent::Delayed::~Delayed ( )
inlinevirtual

Member Function Documentation

virtual long long decaf::util::concurrent::Delayed::getDelay ( const TimeUnit unit)
pure virtual

Returns the remaining delay associated with this object, in the given time unit.

Parameters
unitThe time unit
Returns
the remaining delay; zero or negative values indicate that the delay has already elapsed

The documentation for this class was generated from the following file: