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

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(VOCAL_FIFOBASE_H)
  2. #define VOCAL_FIFOBASE_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 FifoBase_h_Version =
  53.     "$Id: FifoBase.h,v 1.19 2001/06/27 01:43:45 bko Exp $";
  54. #include "Mutex.hxx"
  55. #include "Condition.hxx"
  56. #include "TimerContainer.hxx"
  57. #include "Sptr.hxx"
  58. #include "NonCopyable.hxx"
  59. #include <list>
  60. #ifndef WIN32
  61. typedef Vocal::TimeAndDate::milliseconds_t milliseconds_t;
  62. #else
  63. using namespace Vocal::TimeAndDate;
  64. #endif
  65. namespace Vocal {
  66.     namespace TimeAndDate {
  67.         class TimeVal;
  68.     }
  69. }
  70. /** Infrastructure common to VOCAL.
  71.  */
  72. namespace Vocal 
  73. {
  74. using Vocal::TimeAndDate::TimeVal;
  75. using Vocal::Threads::Mutex;
  76. using Vocal::Threads::Condition;
  77. using std::list;
  78. /** First in first out list interface, with the added functionality of 
  79.  *  being able to handle timed entries.
  80.  */
  81. template < class Msg >
  82. class FifoBase : public NonCopyable
  83. {
  84.     public:
  85.         /** Id for delayed events. Needed to cancel an event.
  86.          */
  87.         typedef Vocal::TimeAndDate::TimerEntryId EventId;
  88.     protected:
  89.         /** Create an empty fifo.
  90.          */
  91.         FifoBase();
  92.     public:
  93.         /** Delete the fifo.
  94.          */
  95.         virtual ~FifoBase();
  96.         /** Add a message to the fifo.
  97.          */
  98.         void add(const Msg &);
  99.         /** If the relative timeout is greater than 0, the message will 
  100.          *  be added to the fifo after the number of milliseconds have passed.
  101.          *          
  102.  *  The returned value is an opaque id that can be used
  103.          *  to cancel the event before the timer expires. If the
  104.          *  time is specified as 0, this defaults the to the
  105.          *  regular add(), returning an id of 0.
  106.          */
  107.         EventId addDelay(
  108.             const Msg &,
  109.             const TimeVal & relativeTimeout);
  110.         /** If the expiry time is later than the time now, the message will 
  111.          *  be added to the fifo after the time has passed.
  112.          *          
  113.  *  The returned value is an opaque id that can be used
  114.          *  to cancel the event before the timer expires. If the
  115.          *  time is specified as 0, this defaults the to the
  116.          *  regular add(), returning an id of 0.
  117.          */
  118.         EventId addUntil(
  119.             const Msg &,
  120.             const TimeVal & when);
  121.         /** If the relative timeout (in milliseconds) is greater than 0, 
  122.  *  the message will be added to the fifo after the number of 
  123.  *  milliseconds have passed.
  124.          *          
  125.  *  The returned value is an opaque id that can be used
  126.          *  to cancel the event before the timer expires. If the
  127.          *  time is specified as 0, this defaults the to the
  128.          *  regular add(), returning an id of 0.
  129.          */
  130.         EventId addDelayMs(
  131.             const Msg &,
  132.             const milliseconds_t relativeTimeout);
  133.         /** If the expiry time (in milliseconds) is later than the
  134.          *  time now, the message will be added to the fifo after the
  135.          *  time has passed.
  136.          *          
  137.  *  The returned value is an opaque id that can be used
  138.          *  to cancel the event before the timer expires. If the
  139.          *  time is specified as 0, this defaults the to the
  140.          *  regular add(), returning an id of 0.
  141.          */
  142.         EventId addUntilMs(
  143.             const Msg &,
  144.             const milliseconds_t when);
  145.         /** Cancel a delayed event.
  146.          */
  147.         void cancel(EventId);
  148.         /** Blocks until a message is available, or the specified timeout has
  149.          *  expired. If the return code is 0, then the fifo was interrupted
  150.          *  via a signal or the timeout expired without a message being added
  151.          *  to the queue. Using block is the only way to guarantee detection
  152.          *  of a signal has been thrown.
  153.          */
  154.         int block(milliseconds_t relativeTimeout = -1)
  155.         throw ( VException );
  156.         /** Returns the first message available. It will wait if no
  157.          *  messages are available. If a signal interrupts the wait,
  158.          *  it will retry the wait. Signals can therefore not be caught
  159.          *  via getNext. If you need to detect a signal, use block
  160.          *  prior to calling getNext.
  161.          */
  162.         Msg getNext() throw ( VException );
  163.         /** Get the current size of the fifo. Note that the current
  164.          *  size includes all of the pending events, even those which
  165.          *  have not yet activated so you should not use this function
  166.          *  to determine whether a call to getNext() will block or not.
  167.          *  Use messageAvailable() instead.
  168.          */
  169.         unsigned int size() const;
  170.         /** Get the current number of messages available. Note that 
  171.          *  the size does not include all of the pending events.
  172.          *  You may not want to this function to determine the number of times
  173.          *  you could call getNext() before it would block, since messages
  174.          *  may become available during message processing. Consider using 
  175.          *  messageAvailable() instead.
  176.          */
  177.         unsigned int sizeAvailable() const;
  178.         /** Get the current number of messages pending. Note that the current
  179.          *  size does not include the available messages. You should not use 
  180.          *  this function to determine whether a call to getNext() will block 
  181.          *  or not. Use messageAvailable() instead.
  182.          */
  183.         unsigned int sizePending() const;
  184.         /** Returns true if a message is available.
  185.          */
  186.         bool messageAvailable();
  187.         /** Indicate that the poll no longer accepts messages.
  188.          */
  189.         void shutdown();
  190.         /** Relational operators. Useful if this is ever in a container.
  191.          */
  192.         bool operator==(const FifoBase &) const;
  193.         /** Relational operators. Useful if this is ever in a container.
  194.          */
  195.         bool operator!=(const FifoBase &) const;
  196.         /** Relational operators. Useful if this is ever in a container.
  197.          */
  198.         bool operator< (const FifoBase &) const;
  199.         /** Relational operators. Useful if this is ever in a container.
  200.          */
  201.         bool operator<=(const FifoBase &) const;
  202.         /** Relational operators. Useful if this is ever in a container.
  203.          */
  204.         bool operator> (const FifoBase &) const;
  205.         /** Relational operators. Useful if this is ever in a container.
  206.          */
  207.         bool operator>=(const FifoBase &) const;
  208.     protected:
  209.         /** Returns true if a message is available. The default implementation
  210.          *  looks at the size of the fifo. Derived classes may also observe
  211.          *  other resources as well. Note that the mutex should not be locked
  212.          *  by this routine, since it would cause a deadlock.
  213.          */
  214.         virtual bool messageAvailableNoLock();
  215.         /** Wake's up the blocked thread. Note that the mutex is locked
  216.          *  upon entry. It is the responsibility of the user to unlock
  217.          *  the mutex if necessary, making sure to relock it before exit.
  218.          */
  219.         virtual void wakeup() throw ( VException ) = 0;
  220.         /** Blocks the thread, for the given time, waiting for a message.
  221.          *  Note that the mutex is locked upon entry. It is the responsibility
  222.          *  of the user to unlock the mutex if necessary, making sure
  223.          *  to relock it before exit. The return code is positive for
  224.          *  to indicate activity, i.e. messages added to the queue. For
  225.          *  a signal or a timeout, 0 should be returned.
  226.          */
  227.         virtual int wait(milliseconds_t relativeTimeout)
  228.         throw ( VException ) = 0;
  229.         typedef list < Sptr < Msg > > MessageContainer;
  230.         /**
  231.          */
  232.         MessageContainer    myFifo;
  233.         /** Protects fifo and timer.
  234.          */
  235.         mutable VMutex     myMutex;
  236.     private:
  237.         int blockNoLock(milliseconds_t relativeTimeout = -1)
  238.             throw ( VException );
  239.         void postAddTimed(const EventId &);
  240.         Vocal::TimeAndDate::TimerContainer < Msg > myTimer;
  241.         bool myShutdown;
  242. };
  243. /** Opaque id so that time delayed fifo events may be cancelled.
  244.  *  For backwards compatibility. Use FifoBase::EventId instead.
  245.  */
  246. typedef     Vocal::TimeAndDate::TimerEntryId  FifoEventId;
  247. } // namespace Vocal
  248. #ifndef WIN32
  249. #include "FifoBase.cc"
  250. #endif
  251. #ifdef WIN32
  252. #include "FifoBase-win32.cxx"
  253. #endif
  254. #endif // !defined(VOCAL_FIFOBASE_H)