LLAvatarListDatum< T > Class Template Reference

Template class for a piece of data that must be retrieved. More...

#include <llfloateravatarlist.h>

Inheritance diagram for LLAvatarListDatum< T >:

[legend]Collaboration diagram for LLAvatarListDatum< T >:


Public Member Functions
	LLAvatarListDatum ()
BOOL	retryNeeded ()
	Determines whether a data re-request is needed.
void	requestStarted ()
	Notifies the object that a request was started.
BOOL	requestIfNeeded ()
	retryNeeded and requestStarted combined
DATA_STATUS	getStatus ()
	Returns the request status.
T &	getValue ()
void	setValue (T val)
void	setRequestDelay (F32 delay)
void	setMaxPending (U32 count)
Private Attributes
T	mValue
DATA_STATUS	mStatus
F32	mRetryDelay
	How long to wait before trying to re-request the data.
F32	mFirstRequestTimeout
	How long to wait on the first attempt to get data.
F32	mMaxRequestTimeout
	Maximum delay between retries.
LLTimer	mRequestTimer
	Timer for the current request.
F32	mRequestDelay
	Time between requests of the same type.
U32	mMaxPending
	Maximum amount of pending requests.
Static Private Attributes
static LLTimer	mRequestDelayTimer
	Timer used to separate requests, to avoid flooding the server.
static U32	mPending = 0
	Amount of pending requests.
Friends
class	LLFloaterAvatarList

Detailed Description

template<class T>
class LLAvatarListDatum< T >

Template class for a piece of data that must be retrieved.

This class handles the storage, retries and delays required to obtain a piece of data..

Definition at line 95 of file llfloateravatarlist.h.

Constructor & Destructor Documentation

template<class T>

LLAvatarListDatum< T >::LLAvatarListDatum ( ) [inline]

Definition at line 98 of file llfloateravatarlist.h.

Member Function Documentation

template<class T>

DATA_STATUS LLAvatarListDatum< T >::getStatus ( ) [inline]

Returns the request status.

Definition at line 200 of file llfloateravatarlist.h.

Referenced by LLFloaterAvatarList::getAvatarColor(), and LLFloaterAvatarList::refreshAvatarList().

template<class T>

T& LLAvatarListDatum< T >::getValue ( ) [inline]

Definition at line 214 of file llfloateravatarlist.h.

Referenced by LLFloaterAvatarList::getAvatarColor(), LLAvatarListEntry::getIsLinden(), LLFloaterAvatarList::refreshAvatarList(), and LLAvatarListEntry::setAccountCustomTitle().

template<class T>

BOOL LLAvatarListDatum< T >::requestIfNeeded ( ) [inline]

retryNeeded and requestStarted combined

Returns:: TRUE if a re-request is needed

Definition at line 186 of file llfloateravatarlist.h.

Referenced by LLFloaterAvatarList::refreshAvatarList().

template<class T>

void LLAvatarListDatum< T >::requestStarted ( ) [inline]

Notifies the object that a request was started.

Definition at line 155 of file llfloateravatarlist.h.

Referenced by LLAvatarListDatum< LLAvatarInfo >::requestIfNeeded().

template<class T>

BOOL LLAvatarListDatum< T >::retryNeeded ( ) [inline]

Determines whether a data re-request is needed.

Returns:: TRUE if a re-request is needed

This function takes the decision based on whether the data has been already retrieved, the last data request was long enough ago, and the request rate being low enough.

A FALSE return value doesn't mean that everything is OK, only that a retry shouldn't be made at this time.

Definition at line 124 of file llfloateravatarlist.h.

Referenced by LLAvatarListDatum< LLAvatarInfo >::requestIfNeeded().

template<class T>

void LLAvatarListDatum< T >::setMaxPending ( U32 count ) [inline]