summaryrefslogtreecommitdiff
path: root/indra/llcommon/lltimer.h
diff options
context:
space:
mode:
authorJames Cook <james@lindenlab.com>2007-01-02 08:33:20 +0000
committerJames Cook <james@lindenlab.com>2007-01-02 08:33:20 +0000
commit420b91db29485df39fd6e724e782c449158811cb (patch)
treeb471a94563af914d3ed3edd3e856d21cb1b69945 /indra/llcommon/lltimer.h
Print done when done.
Diffstat (limited to 'indra/llcommon/lltimer.h')
-rw-r--r--indra/llcommon/lltimer.h142
1 files changed, 142 insertions, 0 deletions
diff --git a/indra/llcommon/lltimer.h b/indra/llcommon/lltimer.h
new file mode 100644
index 0000000000..69e786c50a
--- /dev/null
+++ b/indra/llcommon/lltimer.h
@@ -0,0 +1,142 @@
+/**
+ * @file lltimer.h
+ * @brief Cross-platform objects for doing timing
+ *
+ * Copyright (c) 2000-$CurrentYear$, Linden Research, Inc.
+ * $License$
+ */
+
+#ifndef LL_TIMER_H
+#define LL_TIMER_H
+
+#if LL_LINUX || LL_DARWIN
+# include <time.h>
+# include <sys/time.h>
+#endif
+
+#include <list>
+
+// units conversions
+#ifndef USEC_PER_SEC
+ const U32 USEC_PER_SEC = 1000000;
+#endif
+const U32 SEC_PER_MIN = 60;
+const U32 MIN_PER_HOUR = 60;
+const U32 USEC_PER_MIN = USEC_PER_SEC * SEC_PER_MIN;
+const U32 USEC_PER_HOUR = USEC_PER_MIN * MIN_PER_HOUR;
+const U32 SEC_PER_HOUR = SEC_PER_MIN * MIN_PER_HOUR;
+const F64 SEC_PER_USEC = 1.0 / (F64) USEC_PER_SEC;
+
+class LLTimer
+{
+public:
+ static LLTimer *sTimer; // global timer
+
+protected:
+ U64 mLastClockCount;
+ U64 mExpirationTicks;
+ BOOL mStarted;
+
+public:
+ LLTimer();
+ ~LLTimer();
+
+ static void initClass() { if (!sTimer) sTimer = new LLTimer; }
+ static void cleanupClass() { delete sTimer; sTimer = NULL; }
+
+ // Return a high precision number of seconds since the start of
+ // this application instance.
+ static F64 getElapsedSeconds()
+ {
+ return sTimer->getElapsedTimeF64();
+ }
+
+ // Return a high precision usec since epoch
+ static U64 getTotalTime();
+
+ // Return a high precision seconds since epoch
+ static F64 getTotalSeconds();
+
+
+ // MANIPULATORS
+ void start() { reset(); mStarted = TRUE; }
+ void stop() { mStarted = FALSE; }
+ void reset(); // Resets the timer
+ void setLastClockCount(U64 current_count); // Sets the timer so that the next elapsed call will be relative to this time
+ void setTimerExpirySec(F32 expiration);
+ BOOL checkExpirationAndReset(F32 expiration);
+ BOOL hasExpired();
+ F32 getElapsedTimeAndResetF32(); // Returns elapsed time in seconds with reset
+ F64 getElapsedTimeAndResetF64();
+
+ F32 getRemainingTimeF32();
+
+ static BOOL knownBadTimer();
+
+ // ACCESSORS
+ F32 getElapsedTimeF32() const; // Returns elapsed time in seconds
+ F64 getElapsedTimeF64() const; // Returns elapsed time in seconds
+
+ BOOL getStarted() const { return mStarted; }
+
+
+ static U64 getCurrentClockCount(); // Returns the raw clockticks
+};
+
+//
+// Various functions for initializing/accessing clock and timing stuff. Don't use these without REALLY knowing how they work.
+//
+U64 get_clock_count();
+F64 calc_clock_frequency(U32 msecs);
+void update_clock_frequencies();
+
+
+// Sleep for milliseconds
+void ms_sleep(long ms);
+
+// Yield
+//void llyield(); // Yield your timeslice - not implemented yet for Mac, so commented out.
+
+// Returns the correct UTC time in seconds, like time(NULL).
+// Useful on the viewer, which may have its local clock set wrong.
+U32 time_corrected();
+
+// Correction factor used by time_corrected() above.
+extern S32 gUTCOffset;
+
+// Is the current computer (in its current time zone)
+// observing daylight savings time?
+BOOL is_daylight_savings();
+
+// Converts internal "struct tm" time buffer to Pacific Standard/Daylight Time
+// Usage:
+// S32 utc_time;
+// utc_time = time_corrected();
+// struct tm* internal_time = utc_to_pacific_time(utc_time, gDaylight);
+struct tm* utc_to_pacific_time(S32 utc_time, BOOL pacific_daylight_time);
+
+void microsecondsToTimecodeString(U64 current_time, char *tcstring);
+void secondsToTimecodeString(F32 current_time, char *tcstring);
+
+// class for scheduling a function to be called at a given frequency (approximate, inprecise)
+class LLEventTimer
+{
+public:
+ LLEventTimer(F32 period); // period is the amount of time between each call to tick()
+ virtual ~LLEventTimer();
+
+ //function to be called at the supplied frequency
+ virtual void tick() = 0;
+
+ static void updateClass();
+
+protected:
+ LLTimer mTimer;
+ F32 mPeriod;
+
+private:
+ //list of active timers
+ static std::list<LLEventTimer*> sActiveList;
+};
+
+#endif