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

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(VOCAL_CONTROL_EVENT_HXX)
  2. #define VOCAL_CONTROL_EVENT_HXX
  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 ControlEvent_hxx_Version =
  53.     "$Id: ControlEvent.hxx,v 1.2 2001/04/03 07:51:11 icahoon Exp $";
  54. #include "Event.hxx"
  55. #include "Sptr.hxx"
  56. #include "FifoBase.h"
  57. #include "Mutex.hxx"
  58. /** Infrastructure common to VOCAL.
  59.  */
  60. namespace Vocal 
  61. {
  62. /** Infrastructure common to VOCAL to provide event based services.<br><br>
  63.  */
  64. namespace Services
  65. {
  66. using Vocal::Threads::Mutex;
  67. /** ControlEvent is used to manage the starting, stopping and shutting down of
  68.  *  a thread that waits on Fifo<Event>'s.<br><br>
  69.  *
  70.  *  It is best to only use these within an Sptr.
  71.  *
  72.  *  @see    Vocal::Services::Event
  73.  *  @see    FifoBase
  74.  */
  75. class ControlEvent : public Vocal::Services::Event
  76. {
  77.     public:
  78.         /** The type of control event.
  79.          */
  80.         enum Type
  81.         {
  82.             START = 0,
  83.             STOP,
  84.             SHUTDOWN
  85.      };
  86.         /** Create a control event with a type and an optional reply
  87.          *  fifo. If the reply fifo is set, the control event can be
  88.          *  used as a request (rather than a command), and the response
  89.          *  can be communicated via the returncode.
  90.          */
  91.         ControlEvent(Type, FifoBase< Sptr<Event> > * event = 0);
  92.         /**  Create a control event with a type and a reply
  93.          *  fifo. The control event is used as a request (rather than a 
  94.  *  command), and the response can be communicated via the returncode.
  95.          */
  96.         ControlEvent(Type, FifoBase< Sptr<Event> > &);
  97.      /** Virtual destructor.
  98.  */
  99.         virtual ~ControlEvent();
  100.      /** Name of the this class of event, being "ControlEvent".
  101.  */
  102.         virtual const char* const name() const;
  103.      /** Return the type of ControlEvent.
  104.  */
  105.         Type getType() const;
  106.      /** Set the return code for a returned response.
  107.  */
  108.         void setReturnCode(int);
  109.      /** Get the return code for a returned response.
  110.  */
  111.         int     getReturnCode() const;
  112.      /** Set the reply fifo for a returned response.
  113.  */
  114.         void setReplyFifo(
  115.             FifoBase< Sptr<Event> > &
  116.         );
  117.      /** Get the return code for a returned response.
  118.  */
  119.         FifoBase< Sptr<Event> > * getReplyFifo() const;
  120.         /** To uniquely identify a request. Useful if this control event is
  121.          *  a request. The fifo waiting for the response can the uniquely
  122.          *  identify the response, in the case they sent out multiple control
  123.          *  events simultaneously.
  124.          */
  125.         int     getControlEventId() const;
  126.         /** Write the event to a stream.
  127.          */
  128.         virtual ostream & writeTo(ostream &) const;
  129.     private:
  130.         // nextId is a globally shared resource, so it needs to be protected.
  131.         //
  132.         static Mutex                 myNextIdMutex;
  133.         static int                     myNextId;
  134.         Type                         myType;
  135.         int                             myReturnCode;
  136.         FifoBase < Sptr < Event > > * myFifo;
  137.         int                             myId;
  138. };
  139. } // namespace Services
  140. } // namespace Vocal
  141. #endif // !defined(VOCAL_CONTROL_EVENT_HXX)