1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD: releng/10.3/sys/dev/isci/scil/sci_base_observer.h 231136 2012-02-07 17:43:58Z jimharris $ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_BASE_OBSERVER_H_ 55230557Sjimharris#define _SCI_BASE_OBSERVER_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the structures, constants, and methods 61230557Sjimharris * common to all base observer object definitions. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#if defined(SCI_LOGGING) 69230557Sjimharris 70230557Sjimharrisstruct SCI_BASE_OBSERVER; 71230557Sjimharrisstruct SCI_BASE_SUBJECT; 72230557Sjimharris 73230557Sjimharris/** 74230557Sjimharris * @typedef SCI_BASE_OBSERVER_UPDATE_T 75230557Sjimharris * 76230557Sjimharris * @brief This type definition defines the format for the update method 77230557Sjimharris * that is invoked for all observers participating in the observer 78230557Sjimharris * design pattern. 79230557Sjimharris */ 80230557Sjimharristypedef void (*SCI_BASE_OBSERVER_UPDATE_T)( 81230557Sjimharris struct SCI_BASE_OBSERVER *this_observer, 82230557Sjimharris struct SCI_BASE_SUBJECT *the_subject 83230557Sjimharris); 84230557Sjimharris 85230557Sjimharris/** 86230557Sjimharris * @struct SCI_BASE_OBSERVER 87230557Sjimharris * 88230557Sjimharris * @brief This structure defines the fields necessary for an object that 89230557Sjimharris * intends to participate as an observer. 90230557Sjimharris */ 91230557Sjimharristypedef struct SCI_BASE_OBSERVER 92230557Sjimharris{ 93230557Sjimharris /** 94230557Sjimharris * This filed points to the next observer if there is one 95230557Sjimharris */ 96230557Sjimharris struct SCI_BASE_OBSERVER *next; 97230557Sjimharris 98230557Sjimharris /** 99230557Sjimharris * This field defines the function pointer that is invoked in order to 100230557Sjimharris * notify the observer of a change in the subject (i.e. observed object). 101230557Sjimharris */ 102230557Sjimharris SCI_BASE_OBSERVER_UPDATE_T update; 103230557Sjimharris 104230557Sjimharris} SCI_BASE_OBSERVER_T; 105230557Sjimharris 106230557Sjimharris/** 107230557Sjimharris * @brief This method is the basic constructor for the observer 108230557Sjimharris * 109230557Sjimharris * @param[in] this_observer This parameter specifies the observer to 110230557Sjimharris * be constructed. 111230557Sjimharris * @param[in] update This parameter specifies the update method to be 112230557Sjimharris * invoked for this observer. 113230557Sjimharris * 114230557Sjimharris * @return none 115230557Sjimharris */ 116230557Sjimharrisvoid sci_base_observer_construct( 117230557Sjimharris struct SCI_BASE_OBSERVER *this_observer, 118230557Sjimharris SCI_BASE_OBSERVER_UPDATE_T update 119230557Sjimharris); 120230557Sjimharris 121230557Sjimharris/** 122230557Sjimharris * @brief This method performs the actions of construction and attaches to the 123230557Sjimharris * subject. 124230557Sjimharris * 125230557Sjimharris * @pre The the_subject to be observed must be constructed before this call. 126230557Sjimharris * 127230557Sjimharris * @param[in] this_observer This parameter specifies the observer to construct 128230557Sjimharris * an attach to the subject. 129230557Sjimharris * @param[in] update This parameter is the update function that is passed to 130230557Sjimharris * the constructor. 131230557Sjimharris * @param[in] the_subject This parameter specifies the subject to observe. 132230557Sjimharris */ 133230557Sjimharrisvoid sci_base_observer_initialize( 134230557Sjimharris struct SCI_BASE_OBSERVER *this_observer, 135230557Sjimharris SCI_BASE_OBSERVER_UPDATE_T update, 136230557Sjimharris struct SCI_BASE_SUBJECT *the_subject 137230557Sjimharris); 138230557Sjimharris 139230557Sjimharris/** 140230557Sjimharris * @brief This method will call the observers update function 141230557Sjimharris * 142230557Sjimharris * @param[in] this_observer This parameter specifies the observer to be 143230557Sjimharris * notified. 144230557Sjimharris * @param[in] the_subject This parameter indicates the subject for which 145230557Sjimharris * the update call is occurring. 146230557Sjimharris * 147230557Sjimharris * @return none 148230557Sjimharris */ 149230557Sjimharrisvoid sci_base_observer_update( 150230557Sjimharris struct SCI_BASE_OBSERVER *this_observer, 151230557Sjimharris struct SCI_BASE_SUBJECT *the_subject 152230557Sjimharris); 153230557Sjimharris 154230557Sjimharris#else // defined(SCI_LOGGING) 155230557Sjimharris 156230557Sjimharristypedef U8 SCI_BASE_OBSERVER_T; 157230557Sjimharris#define sci_base_observer_construct 158230557Sjimharris#define sci_base_observer_initialize 159230557Sjimharris#define sci_base_observer_update 160230557Sjimharris 161230557Sjimharris#endif // defined(SCI_LOGGING) 162230557Sjimharris 163230557Sjimharris#ifdef __cplusplus 164230557Sjimharris} 165230557Sjimharris#endif // __cplusplus 166230557Sjimharris 167230557Sjimharris#endif // _SCI_BASE_OBSERVER_H_ 168