blocxx
|
00001 /******************************************************************************* 00002 * Copyright (C) 2005, Vintela, Inc. All rights reserved. 00003 * Copyright (C) 2006, Novell, Inc. All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions are met: 00007 * 00008 * * Redistributions of source code must retain the above copyright notice, 00009 * this list of conditions and the following disclaimer. 00010 * * Redistributions in binary form must reproduce the above copyright 00011 * notice, this list of conditions and the following disclaimer in the 00012 * documentation and/or other materials provided with the distribution. 00013 * * Neither the name of 00014 * Vintela, Inc., 00015 * nor Novell, Inc., 00016 * nor the names of its contributors or employees may be used to 00017 * endorse or promote products derived from this software without 00018 * specific prior written permission. 00019 * 00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00022 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00023 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 00024 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00025 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 00026 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00027 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00028 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 00029 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00030 * POSSIBILITY OF SUCH DAMAGE. 00031 *******************************************************************************/ 00032 00033 00038 #ifndef BLOCXX_TIMEOUT_TIMER_HPP_INCLUDE_GUARD_ 00039 #define BLOCXX_TIMEOUT_TIMER_HPP_INCLUDE_GUARD_ 00040 00041 #include "blocxx/BLOCXX_config.h" 00042 #include "blocxx/CommonFwd.hpp" 00043 #include "blocxx/Timeout.hpp" 00044 #include "blocxx/DateTime.hpp" 00045 00046 #ifdef BLOCXX_HAVE_SYS_TIME_H 00047 #include <sys/time.h> // for timeval 00048 #endif 00049 #include <time.h> // for timespec 00050 00051 namespace BLOCXX_NAMESPACE 00052 { 00053 00075 class BLOCXX_COMMON_API TimeoutTimer 00076 { 00077 public: 00078 TimeoutTimer(const Timeout& x); 00079 virtual ~TimeoutTimer(); 00080 00087 void start(); 00088 00095 void resetOnLoop(); 00096 00102 void loop(); 00103 00107 bool expired() const; 00108 00112 bool infinite() const; 00113 00114 #ifdef BLOCXX_HAVE_STRUCT_TIMEVAL 00115 // return 0 for infinite, otherwise a pointer to tv, and tv will be modified to contain an interval suitable for use with select(). 00116 ::timeval* asTimeval(::timeval& tv, double maxSeconds) const; 00117 // return 0 for infinite, otherwise a pointer to tv, and tv will be modified to contain an interval suitable for use with select(). 00118 ::timeval* asTimeval(::timeval& tv) const; 00119 #endif 00120 00121 #ifdef BLOCXX_HAVE_STRUCT_TIMESPEC 00122 // fills out ts and returns the address of it. 00123 ::timespec* asTimespec(::timespec& ts) const; 00124 #endif 00125 00126 Timeout asTimeout() const; 00127 Timeout asRelativeTimeout() const; 00128 Timeout asRelativeTimeout(double maxSeconds) const; 00133 Timeout asAbsoluteTimeout() const; 00134 00135 #ifdef BLOCXX_WIN32 00136 // returns INFINITE for an infinite timeout. 00137 ::DWORD asDWORDMs() const; 00138 #endif 00139 00140 // returns -1 for infinite 00141 int asIntMs() const; 00142 int asIntMs(double maxSeconds) const; 00143 00144 private: 00145 00146 double calcSeconds() const; 00147 double calcSeconds(double maxSeconds) const; 00148 00149 // for test purposes, the current time can be faked by a derived class. 00150 virtual DateTime getCurrentTime() const; 00151 00152 Timeout m_timeout; 00153 DateTime m_start; 00154 DateTime m_loopTime; 00155 }; 00156 00157 } // end namespace BLOCXX_NAMESPACE 00158 00159 #endif 00160 00161 00162