PageRenderTime 22ms CodeModel.GetById 1ms RepoModel.GetById 0ms app.codeStats 0ms

/indra/llcommon/lleventtimer.h

https://bitbucket.org/lindenlab/viewer-beta/
C++ Header | 54 lines | 19 code | 7 blank | 28 comment | 0 complexity | f00b9bd0d7de7fb084484edd905ba5c1 MD5 | raw file
Possible License(s): LGPL-2.1
  1. /**
  2. * @file lleventtimer.h
  3. * @brief Cross-platform objects for doing timing
  4. *
  5. * $LicenseInfo:firstyear=2000&license=viewerlgpl$
  6. * Second Life Viewer Source Code
  7. * Copyright (C) 2010, Linden Research, Inc.
  8. *
  9. * This library is free software; you can redistribute it and/or
  10. * modify it under the terms of the GNU Lesser General Public
  11. * License as published by the Free Software Foundation;
  12. * version 2.1 of the License only.
  13. *
  14. * This library is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17. * Lesser General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Lesser General Public
  20. * License along with this library; if not, write to the Free Software
  21. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22. *
  23. * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
  24. * $/LicenseInfo$
  25. */
  26. #ifndef LL_EVENTTIMER_H
  27. #define LL_EVENTTIMER_H
  28. #include "stdtypes.h"
  29. #include "lldate.h"
  30. #include "llinstancetracker.h"
  31. #include "lltimer.h"
  32. // class for scheduling a function to be called at a given frequency (approximate, inprecise)
  33. class LL_COMMON_API LLEventTimer : public LLInstanceTracker<LLEventTimer>
  34. {
  35. public:
  36. LLEventTimer(F32 period); // period is the amount of time between each call to tick() in seconds
  37. LLEventTimer(const LLDate& time);
  38. virtual ~LLEventTimer();
  39. //function to be called at the supplied frequency
  40. // Normally return FALSE; TRUE will delete the timer after the function returns.
  41. virtual BOOL tick() = 0;
  42. static void updateClass();
  43. protected:
  44. LLTimer mEventTimer;
  45. F32 mPeriod;
  46. };
  47. #endif //LL_EVENTTIMER_H