LLKeyThrottle< T > Class Template Reference

#include <llkeythrottle.h>

List of all members.

Public Types

enum  State { THROTTLE_OK, THROTTLE_NEWLY_BLOCKED, THROTTLE_BLOCKED }

Public Member Functions

 LLKeyThrottle (U32 limit, F32 interval)
 ~LLKeyThrottle ()
State noteAction (const T &id, S32 weight=1)
void throttleAction (const T &id)
BOOL isThrottled (const T &id) const

Protected Attributes

LLKeyThrottleImpl< T > & m


Detailed Description

template<class T>
class LLKeyThrottle< T >

Definition at line 89 of file llkeythrottle.h.


Member Enumeration Documentation

template<class T>
enum LLKeyThrottle::State

Enumerator:
THROTTLE_OK 
THROTTLE_NEWLY_BLOCKED 
THROTTLE_BLOCKED 

Definition at line 112 of file llkeythrottle.h.


Constructor & Destructor Documentation

template<class T>
LLKeyThrottle< T >::LLKeyThrottle ( U32  limit,
F32  interval 
) [inline]

Definition at line 92 of file llkeythrottle.h.

References LLKeyThrottleImpl< T >::getTime(), LLKeyThrottle< T >::m, and USEC_PER_SEC.

Here is the call graph for this function:

template<class T>
LLKeyThrottle< T >::~LLKeyThrottle (  )  [inline]

Definition at line 105 of file llkeythrottle.h.

References LLKeyThrottle< T >::m.


Member Function Documentation

template<class T>
State LLKeyThrottle< T >::noteAction ( const T &  id,
S32  weight = 1 
) [inline]

Definition at line 119 of file llkeythrottle.h.

References FALSE, LLKeyThrottleImpl< T >::getTime(), LLKeyThrottle< T >::m, LLKeyThrottle< T >::THROTTLE_BLOCKED, LLKeyThrottle< T >::THROTTLE_NEWLY_BLOCKED, and LLKeyThrottle< T >::THROTTLE_OK.

Referenced by LLKeyThrottle< T >::throttleAction().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T>
void LLKeyThrottle< T >::throttleAction ( const T &  id  )  [inline]

Definition at line 191 of file llkeythrottle.h.

References llmax(), LLKeyThrottle< T >::m, LLKeyThrottle< T >::noteAction(), and TRUE.

Here is the call graph for this function:

template<class T>
BOOL LLKeyThrottle< T >::isThrottled ( const T &  id  )  const [inline]

Definition at line 200 of file llkeythrottle.h.

References FALSE, and LLKeyThrottle< T >::m.


Member Data Documentation

template<class T>
LLKeyThrottleImpl<T>& LLKeyThrottle< T >::m [protected]


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

Generated on Fri May 16 08:51:13 2008 for SecondLife by  doxygen 1.5.5