src/third_party/libjingle/source/talk/xmpp/module.h

   1 /*
   2  * libjingle
   3  * Copyright 2004--2005, Google Inc.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TALK_XMPP_MODULE_H_
  29 #define TALK_XMPP_MODULE_H_
  30
  31 #include "webrtc/libjingle/xmpp/xmppengine.h"
  32
  33 namespace buzz {
  34
  35 class XmppEngine;
  36
  37 //! This is the base class for extension modules.
  38 //! An engine is registered with the module and the module then hooks the
  39 //! appropriate parts of the engine to implement that set of features.  It is
  40 //! important to unregister modules before destructing the engine.
  41 class XmppModule {
  42 public:
  43   virtual ~XmppModule() {}
  44
  45   //! Register the engine with the module.  Only one engine can be associated
  46   //! with a module at a time.  This method will return an error if there is
  47   //! already an engine registered.
  48   virtual XmppReturnStatus RegisterEngine(XmppEngine* engine) = 0;
  49 };
  50
  51 }
  52 #endif  // TALK_XMPP_MODULE_H_