TimerEntry.hxx
上传用户:sy_wanhua
上传日期:2013-07-25
资源大小:3048k
文件大小:5k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #ifndef TIMER_ENTRY_DOT_H
  2. #define TIMER_ENTRY_DOT_H
  3. /* ====================================================================
  4.  * The Vovida Software License, Version 1.0 
  5.  * 
  6.  * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
  7.  * 
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions
  10.  * are met:
  11.  * 
  12.  * 1. Redistributions of source code must retain the above copyright
  13.  *    notice, this list of conditions and the following disclaimer.
  14.  * 
  15.  * 2. Redistributions in binary form must reproduce the above copyright
  16.  *    notice, this list of conditions and the following disclaimer in
  17.  *    the documentation and/or other materials provided with the
  18.  *    distribution.
  19.  * 
  20.  * 3. The names "VOCAL", "Vovida Open Communication Application Library",
  21.  *    and "Vovida Open Communication Application Library (VOCAL)" must
  22.  *    not be used to endorse or promote products derived from this
  23.  *    software without prior written permission. For written
  24.  *    permission, please contact vocal@vovida.org.
  25.  *
  26.  * 4. Products derived from this software may not be called "VOCAL", nor
  27.  *    may "VOCAL" appear in their name, without prior written
  28.  *    permission of Vovida Networks, Inc.
  29.  * 
  30.  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
  31.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
  33.  * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
  34.  * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
  35.  * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
  36.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  37.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  38.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  39.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  41.  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  42.  * DAMAGE.
  43.  * 
  44.  * ====================================================================
  45.  * 
  46.  * This software consists of voluntary contributions made by Vovida
  47.  * Networks, Inc. and many individuals on behalf of Vovida Networks,
  48.  * Inc.  For more information on Vovida Networks, Inc., please see
  49.  * <http://www.vovida.org/>.
  50.  *
  51.  */
  52. static const char* const TimerEntryHeaderVersion =
  53.     "$Id: TimerEntry.hxx,v 1.15 2001/06/27 01:43:45 bko Exp $";
  54. #include "Writer.hxx"
  55. #include "Sptr.hxx"
  56. #include "TimeVal.hxx"
  57. /** Infrastructure common to VOCAL.
  58.  */
  59. namespace Vocal 
  60. {
  61. /** Infrastructure common to VOCAL to manipulate the time.
  62.  */
  63. namespace TimeAndDate
  64. {
  65. #if !defined(VOCAL_MILLISECONDS_T)
  66. #define VOCAL_MILLISECONDS_T
  67. /* 1/1000th of a seconds.<br><br>
  68.  */
  69. typedef int milliseconds_t;
  70. #endif // !defined(VOCAL_MILLISECONDS_T)
  71. /** The key for a timer entry.<br><br>
  72.  */
  73. typedef void * TimerEntryId;
  74. /** An entry in a TimerContainer.<br><br>
  75.  *
  76.  *  A TimerEntry holds some type of event and the time the event is 
  77.  *  supposed to take place. The TimerContainer is an ordered list 
  78.  *  (by time) of TimerEntries.
  79.  *
  80.  *  @see    Vocal::TimeAndDate::TimerContainer
  81.  *  @see    Vocal::TimeAndDate::TimeVal
  82.  */
  83. template < class Msg >
  84. class TimerEntry : public Vocal::IO::Writer
  85. {
  86.     public:
  87. /** Construct with an event and the time of expiration (in ms).
  88.  */
  89.         TimerEntry(Sptr < Msg > , milliseconds_t time, bool relative = true);
  90. /** Construct with an event and the time of expiration.
  91.  */
  92.         TimerEntry(Sptr < Msg > , const TimeVal & time, bool relative = true);
  93. /** Copy constructor.
  94.  */
  95.         TimerEntry(const TimerEntry &);
  96. /** Virtual destructor.
  97.  */
  98.         virtual ~TimerEntry();
  99. /** Assignment operator.
  100.  */
  101.         TimerEntry & operator=(const TimerEntry &);
  102. /** Return the time of expiration for the event.
  103.  */
  104.         milliseconds_t getTimeout() const;
  105. /** Return the opaque id for this timer entry.
  106.  */
  107.         TimerEntryId getId() const;
  108. /** Return the associated event.
  109.  */
  110.         Sptr < Msg > getMessage() const;
  111. /** Returns true if the expiration time for the associcated 
  112.  *  event has passed.
  113.  */
  114.         bool hasExpired() const;
  115. /** Equality relational operator.
  116.  */
  117.         bool operator==(const TimerEntry &) const;
  118. /** Inequality relational operator.
  119.  */
  120.         bool operator!=(const TimerEntry &) const;
  121. /** Less than relational operator.
  122.  */
  123.         bool operator< (const TimerEntry &) const;
  124. /** Less than or equal to relational operator.
  125.  */
  126.         bool operator<=(const TimerEntry &) const;
  127. /** Greater than relational operator.
  128.  */
  129.         bool operator> (const TimerEntry &) const;
  130. /** Greater than or equal to relational operator.
  131.  */
  132.         bool operator>=(const TimerEntry &) const;
  133. /** Write the TimerEntry to an ostream.
  134.  */
  135.         virtual ostream & writeTo(ostream &) const;
  136.     private:
  137.         TimeVal      absExpires_;
  138.         Sptr < Msg >  msg_;
  139. };
  140. } // namespace Time
  141. } // namespace Vocal
  142. #ifndef WIN32
  143. #include "TimerEntry.cc"
  144. #else
  145. #include "TimerEntry-win32.cxx"
  146. #endif
  147. // !defined(TIMER_ENTRY_DOT_H)
  148. #endif