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

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(VOCAL_PROTOCOL_HXX)
  2. #define VOCAL_PROTOCOL_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 Protocol_hxx_Version = 
  53.     "$Id: Protocol.hxx,v 1.14 2001/05/13 10:42:31 icahoon Exp $";
  54. #include "NonCopyable.hxx"
  55. #include "Writer.hxx"
  56. #include "ProtocolException.hxx"
  57. #include "SystemException.hxx"
  58. #include <string>
  59. // Creating a forward reference here due to doc++ bug.
  60. //
  61. namespace Vocal {
  62.     namespace IO {
  63.      class FileDescriptor;
  64.     }
  65. }
  66. /** Infrastructure common to VOCAL.
  67.  */
  68. namespace Vocal 
  69. {
  70. /** Infrastructure in VOCAL related to making network transport layer 
  71.  *  connections.<br><br>
  72.  */
  73. namespace Transport 
  74. {
  75. class ConnectionBrokenException;
  76. class Poll;
  77. /** A Protocol is the object that gives meaning to the bytes
  78.  *  available from a FileDescriptor.<br><br>
  79.  *  
  80.  *  The Poll and Protocol classes together form a type of Subject/Observer
  81.  *  (see Design Patterns, Gamma, et al. page 293) pattern. The Poll object
  82.  *  is the subject whereas the Protocol is the Observer. The Protocol object
  83.  *  register's itself with the Poll. The protocol is interested in being 
  84.  *  notified when it's file descriptor is active. Thus the observer provides 
  85.  *  and an aspect to the server to reduce messaging activity. As well, since 
  86.  *  the observer provides an aspect, the push model is used.
  87.  *
  88.  *  @see    Vocal::Transport::Poll
  89.  *  @see    Vocal::Signaling::PollFifo
  90.  *  @see    Vocal::IO::FileDescriptor
  91.  *  @see    Vocal::ConnectionBrokenException
  92.  */
  93. class Protocol : public Vocal::IO::Writer, public Vocal::NonCopyable
  94. {
  95.     public:
  96.      /** Create with an optional name.
  97.  */
  98.      Protocol(const char * name = 0);
  99.      /** Create with an optional name.
  100.  */
  101.      Protocol(Poll & poll, const char * name = 0);
  102.      /** Virtual destructor
  103.  */
  104.      virtual ~Protocol();
  105.      /** FileDescriptor accessor.
  106.  */
  107. virtual const IO::FileDescriptor &  getFileDescriptor() const = 0;
  108.      /** Callback that notifies the user of information available on the
  109.  *  associated FileDescriptor. The default behavior is to do 
  110.  *  nothing, thus this should be overridden by the user.
  111.  */
  112. virtual void onIncomingAvailable();
  113.      /** Callback that notifies the user of the ability to send information 
  114.  *  on the associated FileDescriptor. The default behavior is to do 
  115.  *  nothing, thus this should be overridden by the user.
  116.  */
  117. virtual void onOutgoingAvailable();
  118.      /** Callback that notifies the user of priority information available 
  119.  *  on the associated FileDescriptor. The default behavior is to do 
  120.  *  nothing, thus this should be overridden by the user.
  121.  */
  122. virtual void onPriority();
  123.      /** Callback that notifies the user that the associated FileDescriptor
  124.  *  has disconnected. If a ConnectionBrokenException had been caught,
  125.  *  it is passed along. The default behavior is to do throw
  126.  *  a HANGUP ProtocolException.
  127.  */
  128. virtual void onDisconnect(ConnectionBrokenException * = 0)
  129.                    throw ( Vocal::Transport::ProtocolException );
  130.      /** Callback that notifies the user that an error has been detected 
  131.  *  on the associated FileDescriptor. If a SystemException had 
  132.  *  been caught, it is passed along. The default behavior is to 
  133.  *  do throw an ERROR ProtocolException.
  134.  */
  135. virtual void onError(SystemException * = 0)
  136.                    throw ( Vocal::Transport::ProtocolException );
  137.      /** If the poll receives an unknown exception, it calls this method,
  138.  *  which by default rethrows the exception. 
  139.  */
  140.      virtual void handleUnknownException();
  141.     
  142.      /** Allow the Protocol to be notified of incoming data.
  143.  */
  144.      void      awaitIncoming(bool);
  145.      /** Query the Protocol state to see if it is to be notified of 
  146.  *  incoming data.
  147.  */
  148. bool      awaitIncoming() const;
  149.      /** Allow the Protocol to be notified of outgoing availability.
  150.  */
  151.      void      awaitOutgoing(bool);
  152.      /** Query the Protocol state to see if it is to be notified of 
  153.  *  outgoing availability.
  154.  */
  155.      bool      awaitOutgoing() const;
  156.      /** Allow the Protocol to be notified of priority messages.
  157.  */
  158.      void      awaitPriority(bool);
  159.      /** Query the Protocol state to see if it is to be notified of 
  160.  *  priority messages.
  161.  */
  162.      bool      awaitPriority() const;
  163.         /**
  164.          */
  165.         const string &  name() const;
  166.         
  167.         
  168.      /** Write the protocol to an ostream.
  169.  */
  170. virtual ostream &   writeTo(ostream &) const;
  171.      /** Equality operator.
  172.  */
  173.      bool      operator==(const Protocol &);
  174.      /** Less than relational operator.
  175.  */
  176.      bool      operator<(const Protocol &);
  177.     private:
  178. bool               myIncoming;
  179.           bool               myOutgoing;
  180. bool               myPriority;
  181. string                myName;
  182.                 Poll                    *   myPoll;
  183. };
  184. } // namespace Transport
  185. } // namespace Vocal
  186. #endif // !defined(VOCAL_PROTOCOL_HXX)