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