ARC SDK
Public Member Functions | Friends
Arc::ExpirationReminder Class Reference

A class intended for internal use within counters. More...

#include <arc/Counter.h>

Public Member Functions

bool operator< (const ExpirationReminder &other) const
 Less than operator, compares "soonness". More...
 
Glib::TimeVal getExpiryTime () const
 Returns the expiry time. More...
 
Counter::IDType getReservationID () const
 Returns the identification number of the reservation. More...
 

Friends

class Counter
 The Counter class needs to be a friend. More...
 

Detailed Description

A class intended for internal use within counters.

This class is used for "reminder objects" that are used for automatic deallocation of self-expiring reservations.

Member Function Documentation

◆ getExpiryTime()

Glib::TimeVal Arc::ExpirationReminder::getExpiryTime ( ) const

Returns the expiry time.

This method returns the expiry time of the reservation that this ExpirationReminder is associated with.

Returns
The expiry time.

◆ getReservationID()

Counter::IDType Arc::ExpirationReminder::getReservationID ( ) const

Returns the identification number of the reservation.

This method returns the identification number of the self-expiring reservation that this ExpirationReminder is associated with.

Returns
The identification number.

◆ operator<()

bool Arc::ExpirationReminder::operator< ( const ExpirationReminder other) const

Less than operator, compares "soonness".

This is the less than operator for the ExpirationReminder class. It compares the priority of such objects with respect to which reservation expires first. It is used when reminder objects are inserted in a priority queue in order to allways place the next reservation to expire at the top.

Friends And Related Function Documentation

◆ Counter

friend class Counter
friend

The Counter class needs to be a friend.


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