2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
33 * * Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * * Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in
37 * the documentation and/or other materials provided with the
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifndef _SCI_BASE_SUBJECT_H_
55 #define _SCI_BASE_SUBJECT_H_
60 * @brief This file contains all of the structures, constants, and methods
61 * common to all subjects object definitions. A subject is a
62 * participant in the observer pattern. A subject represents the
63 * object being observed.
70 #include <dev/isci/scil/sci_types.h>
72 #if defined(SCI_LOGGING)
74 struct SCI_BASE_OBSERVER;
77 * @struct SCI_BASE_SUBJECT
79 * @brief This structure defines the fields common to all subjects that
80 * participate in the observer design pattern
82 typedef struct SCI_BASE_SUBJECT
84 struct SCI_BASE_OBSERVER *observer_list;
90 * @brief This method acts as the basic constructor for the subject.
92 * @param[in] this_subject This fields specifies the subject being
97 void sci_base_subject_construct(
98 SCI_BASE_SUBJECT_T *this_subject
102 * @brief This method will call the update method for all
103 * observers attached to this subject.
105 * @param[in] this_subject This parameter specifies the subject for
106 * which to notify participating observers.
110 void sci_base_subject_notify(
111 SCI_BASE_SUBJECT_T *this_subject
115 * @brief This method will add an observer to the subject.
117 * @param[in] this_subject This parameter specifies the subject for which
118 * an observer is being added.
119 * @param[in] observer This parameter specifies the observer that wishes
120 * it listen for notifications for the supplied subject.
124 void sci_base_subject_attach_observer(
125 SCI_BASE_SUBJECT_T *this_subject,
126 struct SCI_BASE_OBSERVER *observer
130 * @brief This method will remove the observer from the subject.
132 * @param[in] this_subject
133 * @param[in] my_observer
137 void sci_base_subject_detach_observer(
138 SCI_BASE_SUBJECT_T *this_subject,
139 struct SCI_BASE_OBSERVER *my_observer
142 #else // defined(SCI_LOGGING)
144 typedef U8 SCI_BASE_SUBJECT_T;
146 #define sci_base_subject_construct
147 #define sci_base_subject_notify
148 #define sci_base_subject_attach_observer
149 #define sci_base_subject_detach_observer
151 #endif // defined(SCI_LOGGING)
155 #endif // __cplusplus
157 #endif // _SCI_BASE_SUBJECT_H_