1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * This file is provided under a dual BSD/GPLv2 license. When using or 5 * redistributing this file, you may do so under either license. 6 * 7 * GPL LICENSE SUMMARY 8 * 9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23 * The full GNU General Public License is included in this distribution 24 * in the file called LICENSE.GPL. 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 35 * * Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * * Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in 39 * the documentation and/or other materials provided with the 40 * distribution. 41 * 42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53 */ 54 #ifndef _SCI_BASE_SUBJECT_H_ 55 #define _SCI_BASE_SUBJECT_H_ 56 57 /** 58 * @file 59 * 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. 64 */ 65 66 #ifdef __cplusplus 67 extern "C" { 68 #endif // __cplusplus 69 70 #include <dev/isci/scil/sci_types.h> 71 72 #if defined(SCI_LOGGING) 73 74 struct SCI_BASE_OBSERVER; 75 76 /** 77 * @struct SCI_BASE_SUBJECT 78 * 79 * @brief This structure defines the fields common to all subjects that 80 * participate in the observer design pattern 81 */ 82 typedef struct SCI_BASE_SUBJECT 83 { 84 struct SCI_BASE_OBSERVER *observer_list; 85 86 } SCI_BASE_SUBJECT_T; 87 88 89 /** 90 * @brief This method acts as the basic constructor for the subject. 91 * 92 * @param[in] this_subject This fields specifies the subject being 93 * constructed. 94 * 95 * @return none 96 */ 97 void sci_base_subject_construct( 98 SCI_BASE_SUBJECT_T *this_subject 99 ); 100 101 /** 102 * @brief This method will call the update method for all 103 * observers attached to this subject. 104 * 105 * @param[in] this_subject This parameter specifies the subject for 106 * which to notify participating observers. 107 * 108 * @return none 109 */ 110 void sci_base_subject_notify( 111 SCI_BASE_SUBJECT_T *this_subject 112 ); 113 114 /** 115 * @brief This method will add an observer to the subject. 116 * 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. 121 * 122 * @return none 123 */ 124 void sci_base_subject_attach_observer( 125 SCI_BASE_SUBJECT_T *this_subject, 126 struct SCI_BASE_OBSERVER *observer 127 ); 128 129 /** 130 * @brief This method will remove the observer from the subject. 131 * 132 * @param[in] this_subject 133 * @param[in] my_observer 134 * 135 * @return none 136 */ 137 void sci_base_subject_detach_observer( 138 SCI_BASE_SUBJECT_T *this_subject, 139 struct SCI_BASE_OBSERVER *my_observer 140 ); 141 142 #else // defined(SCI_LOGGING) 143 144 typedef U8 SCI_BASE_SUBJECT_T; 145 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 150 151 #endif // defined(SCI_LOGGING) 152 153 #ifdef __cplusplus 154 } 155 #endif // __cplusplus 156 157 #endif // _SCI_BASE_SUBJECT_H_ 158