1311572Sasomers/*- 2311572Sasomers * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3311572Sasomers * 4311572Sasomers * This file is provided under a dual BSD/GPLv2 license. When using or 5311572Sasomers * redistributing this file, you may do so under either license. 6311572Sasomers * 7311572Sasomers * GPL LICENSE SUMMARY 8311572Sasomers * 9311572Sasomers * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10311572Sasomers * 11311572Sasomers * This program is free software; you can redistribute it and/or modify 12311572Sasomers * it under the terms of version 2 of the GNU General Public License as 13311572Sasomers * published by the Free Software Foundation. 14311572Sasomers * 15311572Sasomers * This program is distributed in the hope that it will be useful, but 16311572Sasomers * WITHOUT ANY WARRANTY; without even the implied warranty of 17311572Sasomers * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18311572Sasomers * General Public License for more details. 19311572Sasomers * 20311572Sasomers * You should have received a copy of the GNU General Public License 21311572Sasomers * along with this program; if not, write to the Free Software 22311572Sasomers * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23311572Sasomers * The full GNU General Public License is included in this distribution 24311572Sasomers * in the file called LICENSE.GPL. 25311572Sasomers * 26311572Sasomers * BSD LICENSE 27311572Sasomers * 28311572Sasomers * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29311572Sasomers * All rights reserved. 30311572Sasomers * 31311572Sasomers * Redistribution and use in source and binary forms, with or without 32311572Sasomers * modification, are permitted provided that the following conditions 33311572Sasomers * are met: 34311572Sasomers * 35311572Sasomers * * Redistributions of source code must retain the above copyright 36311572Sasomers * notice, this list of conditions and the following disclaimer. 37311572Sasomers * * Redistributions in binary form must reproduce the above copyright 38311572Sasomers * notice, this list of conditions and the following disclaimer in 39311572Sasomers * the documentation and/or other materials provided with the 40311572Sasomers * distribution. 41311572Sasomers * 42311572Sasomers * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43311572Sasomers * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44311572Sasomers * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45311572Sasomers * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46311572Sasomers * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47311572Sasomers * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48311572Sasomers * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49311572Sasomers * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50311572Sasomers * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51311572Sasomers * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52311572Sasomers * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53311572Sasomers */ 54311572Sasomers#ifndef _SCI_BASE_OBSERVER_H_ 55311572Sasomers#define _SCI_BASE_OBSERVER_H_ 56311572Sasomers 57311572Sasomers/** 58311572Sasomers * @file 59311572Sasomers * 60311572Sasomers * @brief This file contains all of the structures, constants, and methods 61311572Sasomers * common to all base observer object definitions. 62311572Sasomers */ 63311572Sasomers 64311572Sasomers#ifdef __cplusplus 65311572Sasomersextern "C" { 66311572Sasomers#endif // __cplusplus 67311572Sasomers 68#if defined(SCI_LOGGING) 69 70struct SCI_BASE_OBSERVER; 71struct SCI_BASE_SUBJECT; 72 73/** 74 * @typedef SCI_BASE_OBSERVER_UPDATE_T 75 * 76 * @brief This type definition defines the format for the update method 77 * that is invoked for all observers participating in the observer 78 * design pattern. 79 */ 80typedef void (*SCI_BASE_OBSERVER_UPDATE_T)( 81 struct SCI_BASE_OBSERVER *this_observer, 82 struct SCI_BASE_SUBJECT *the_subject 83); 84 85/** 86 * @struct SCI_BASE_OBSERVER 87 * 88 * @brief This structure defines the fields necessary for an object that 89 * intends to participate as an observer. 90 */ 91typedef struct SCI_BASE_OBSERVER 92{ 93 /** 94 * This filed points to the next observer if there is one 95 */ 96 struct SCI_BASE_OBSERVER *next; 97 98 /** 99 * This field defines the function pointer that is invoked in order to 100 * notify the observer of a change in the subject (i.e. observed object). 101 */ 102 SCI_BASE_OBSERVER_UPDATE_T update; 103 104} SCI_BASE_OBSERVER_T; 105 106/** 107 * @brief This method is the basic constructor for the observer 108 * 109 * @param[in] this_observer This parameter specifies the observer to 110 * be constructed. 111 * @param[in] update This parameter specifies the update method to be 112 * invoked for this observer. 113 * 114 * @return none 115 */ 116void sci_base_observer_construct( 117 struct SCI_BASE_OBSERVER *this_observer, 118 SCI_BASE_OBSERVER_UPDATE_T update 119); 120 121/** 122 * @brief This method performs the actions of construction and attaches to the 123 * subject. 124 * 125 * @pre The the_subject to be observed must be constructed before this call. 126 * 127 * @param[in] this_observer This parameter specifies the observer to construct 128 * an attach to the subject. 129 * @param[in] update This parameter is the update function that is passed to 130 * the constructor. 131 * @param[in] the_subject This parameter specifies the subject to observe. 132 */ 133void sci_base_observer_initialize( 134 struct SCI_BASE_OBSERVER *this_observer, 135 SCI_BASE_OBSERVER_UPDATE_T update, 136 struct SCI_BASE_SUBJECT *the_subject 137); 138 139/** 140 * @brief This method will call the observers update function 141 * 142 * @param[in] this_observer This parameter specifies the observer to be 143 * notified. 144 * @param[in] the_subject This parameter indicates the subject for which 145 * the update call is occurring. 146 * 147 * @return none 148 */ 149void sci_base_observer_update( 150 struct SCI_BASE_OBSERVER *this_observer, 151 struct SCI_BASE_SUBJECT *the_subject 152); 153 154#else // defined(SCI_LOGGING) 155 156typedef U8 SCI_BASE_OBSERVER_T; 157#define sci_base_observer_construct 158#define sci_base_observer_initialize 159#define sci_base_observer_update 160 161#endif // defined(SCI_LOGGING) 162 163#ifdef __cplusplus 164} 165#endif // __cplusplus 166 167#endif // _SCI_BASE_OBSERVER_H_ 168