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

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(VOCAL_SERVICE_HXX)
  2. #define VOCAL_SERVICE_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 Service_hxx_Version = 
  53.     "$Id: Service.hxx,v 1.4 2001/04/12 08:15:02 icahoon Exp $";
  54. #include "Runnable.hxx"
  55. #include "Writer.hxx"
  56. #include "NonCopyable.hxx"
  57. #include "FifoBase.h"
  58. #include "EventObserver.hxx"
  59. #include "EventSubject.hxx"
  60. #include "Event.hxx"
  61. #include "Sptr.hxx"
  62. #include "ControlEvent.hxx"
  63. #include "VocalCommon.hxx"
  64. #include <string>
  65. class VException;
  66. /** Infrastructure common to VOCAL.
  67.  */
  68. namespace Vocal 
  69. {
  70. /** Infrastructure common to VOCAL to provide events based services.<br><br>
  71.  */
  72. namespace Services
  73. {
  74. /** A Service is a Runnable that can be started, stopped, and shutdown.<br><br>
  75.  *
  76.  *  It has a Fifo where it blocks, and is an EventSubject, so that
  77.  *  it can distribute Events as they arrive. Usually a Service is
  78.  *  started in it's own Thread.
  79.  *
  80.  *  @see    Vocal::Runnable
  81.  *  @see    Vocal::Behavioral::EventObserver
  82.  *  @see    Vocal::Behavioral::EventSubject
  83.  *  @see    Vocal::Services::Event
  84.  *  @see    Vocal::ReturnCode
  85.  *  @see    Vocal::Services::ControlEvent
  86.  *  @see    Vocal::Threads::Thread
  87.  *  @see    FifoBase
  88.  *  @see    Sptr
  89.  */
  90. class Service : public Vocal::Runnable, public Vocal::IO::Writer, 
  91.                 public Vocal::NonCopyable
  92. {
  93.     protected:
  94.      /** Create a Service given the Fifo of the controling ServiceManager
  95.  *  and an optional name.
  96.       */    
  97.      Service(
  98.     FifoBase< Sptr<Event> > & serviceMgrFifo,
  99.     const char * name = 0
  100. );
  101.     public:
  102.     
  103.      /** Virtual destructor
  104.       */    
  105. virtual ~Service();
  106.      /** Accessor for Service Manager's Fifo.
  107.  */
  108. FifoBase< Sptr<Event> >      &   getServiceManagerFifo();
  109.      /** Accessor for Service Manager's Fifo.
  110.  */
  111. const FifoBase< Sptr<Event> > &   getServiceManagerFifo() const;
  112.      /** Accessors for Fifo.
  113.  */
  114. virtual FifoBase< Sptr<Event> >      &   getFifo() = 0;
  115.      /** Accessors for Fifo.
  116.  */
  117. virtual const FifoBase< Sptr<Event> > &   getFifo() const = 0;
  118.      /** Accessor for EventSubject.
  119.  */
  120. EventSubject< Sptr<Event> >      & getEventSubject();
  121.      /** Accessor for EventSubject.
  122.  */
  123. const EventSubject< Sptr<Event> >   & getEventSubject() const;
  124.      /** Runnable entry point.
  125.  */
  126.      virtual ReturnCode   run();
  127.      /** Subscribe the message observer for incoming events.
  128.  */
  129. void           subscribe(EventObserver< Sptr<Event> > &);
  130.      /** Unsubscribe the message observer for incoming events.
  131.  */
  132. void           unsubscribe(EventObserver< Sptr<Event> > &);
  133. /** For logging.
  134.  */
  135. ostream &            writeTo(ostream &) const;
  136.         /** Returns the name of the service.
  137.          */
  138.         const string &          name() const;
  139.     protected:
  140.     
  141. /** User callback called when a valid start request has been issued. 
  142.          *  A start request may be issued at the start of the service's
  143.          *  lifetime, or after a successful stop request.
  144.  */
  145. virtual ReturnCode      onStart();
  146. /** User callback called when a valid stop request has been issued. 
  147.          *  The service manager may issue a start after a successful stop.
  148.  */
  149. virtual ReturnCode      onStop();
  150. /** User callback called when a valid shutdown command has been 
  151.          *  issued. When issued the service will be going away very soon, 
  152.          *  so you need to cleanup. The shutdown command does not require 
  153.          *  a stop request to be made first.
  154.  */
  155. virtual void      onShutdown();
  156.      /** Handle an exception thrown by the fifo. The default behavior is 
  157.       *  to ignore the exception. Return true to shutdown, which will cause 
  158.       *  this thread to exit.
  159.  */
  160. virtual bool      onVException(VException &);
  161.      /** Handle an unknown exception thrown by the fifo. The default 
  162.       *  behavior is to do a hardShutdown and exit the thread by returning
  163.       *  true. Return true to shutdown, which will cause this thread 
  164.       *  to exit.
  165.  */
  166. virtual bool      onException();
  167.      /** Gets the message, detects if it is a control event. If
  168.       *  so, it calls the appropriate callback. Otherwise the
  169.       *  event is send to the subscribed observers.
  170.  */
  171.      virtual bool         processMessages(int);
  172.      /** A hard shutdown stops the service by calling onStop with 
  173.       *  a zero stopEvent, and sends a STOP ControlEvent to the 
  174.       *  service manager's fifo. It then shuts down the service by 
  175.       *  calling onShutdown with a zero shutdownEvent and sends 
  176.       *  the SHUTDOWN ControlEvent to the service manager's fifo.
  177.  */
  178.      void           hardShutdown(ReturnCode errorCode);
  179.     private:
  180. /** Handle a start request. If the start request comes from
  181.          *  the service manager, the start request is processed, setting the return code
  182.       *  to SUCCESS. The on
  183.  */
  184. void                 start(Sptr<ControlEvent> startEvent);
  185. /** Handle a stop request. The stopEvent may be zero, 
  186.       *  indicating the service is stopping itself, usually on error.
  187.       *  Otherwise the stopEvent will be the event sent from an
  188.       *  outside source, hopefully the service manager. The default 
  189.       *  action is to return the stop request if non-zero, setting 
  190.       *  the return code to SUCCESS. If the stopEvent is zero, 
  191.       *  nothing will be done by default.
  192.  */
  193. virtual void      stop(Sptr<ControlEvent> stopEvent);
  194. /** Handle a shutdown command. The shutdownEvent may be
  195.       *  zero, indicating that the service is shutting down itself,
  196.       *  usually on error. The default action is to do nothing.
  197.  */
  198. virtual void      shutdown(Sptr<ControlEvent> shutdownEvent);
  199. FifoBase< Sptr<Event> >     & myServiceManagerFifo;
  200.      EventSubject< Sptr<Event> >  mySubject;
  201. string                myName;
  202. };
  203. } // namespace Services
  204. } // namespace Vocal
  205. #endif // !defined(VOCAL_SERVICE_HXX)