contrib/opencsd/decoder/include/common/comp_attach_notifier_i.h

   1 /*!
   2  * \file       comp_attach_notifier_i.h
   3  * \brief      OpenCSD : Component attach point notifier interface.
   4  *
   5  * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
   6  */
   7
   8 /*
   9  * Redistribution and use in source and binary forms, with or without modification,
  10  * are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright notice,
  13  * this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  * this list of conditions and the following disclaimer in the documentation
  17  * and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the copyright holder nor the names of its contributors
  20  * may be used to endorse or promote products derived from this software without
  21  * specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  26  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef ARM_COMP_ATTACH_NOTIFIER_I_H_INCLUDED
  36 #define ARM_COMP_ATTACH_NOTIFIER_I_H_INCLUDED
  37
  38 /*!
  39  * @class IComponentAttachNotifier
  40  * @addtogroup ocsd_infrastructure
  41  * @brief Notification interface for attachment.
  42  *
  43  *  Interface to the componentAttachPt classes that allow notification on component
  44  *  connect and disconnect.
  45  */
  46 class IComponentAttachNotifier {
  47 public:
  48     IComponentAttachNotifier() {};  /**< Default interface constructor */
  49     virtual ~IComponentAttachNotifier() {}; /**< Default interface destructor */
  50
  51     /*!
  52      * Callback called by the componentAttachPt() classes when a component is attached
  53      * to or detached from the attach point.
  54      *
  55      * @param num_attached : number of remaining components attached to the point after the
  56      *                       operation that triggered the notification.
  57      */
  58     virtual void attachNotify(const int num_attached) = 0;
  59 };
  60
  61 #endif // ARM_COMP_ATTACH_NOTIFIER_I_H_INCLUDED
  62
  63 /* End of File comp_attach_notifier_i.h */