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$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_BASE_SUBJECT_H_ 55230557Sjimharris#define _SCI_BASE_SUBJECT_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the structures, constants, and methods 61230557Sjimharris * common to all subjects object definitions. A subject is a 62230557Sjimharris * participant in the observer pattern. A subject represents the 63230557Sjimharris * object being observed. 64230557Sjimharris */ 65230557Sjimharris 66230557Sjimharris#ifdef __cplusplus 67230557Sjimharrisextern "C" { 68230557Sjimharris#endif // __cplusplus 69230557Sjimharris 70230557Sjimharris#include <dev/isci/scil/sci_types.h> 71230557Sjimharris 72230557Sjimharris#if defined(SCI_LOGGING) 73230557Sjimharris 74230557Sjimharrisstruct SCI_BASE_OBSERVER; 75230557Sjimharris 76230557Sjimharris/** 77230557Sjimharris * @struct SCI_BASE_SUBJECT 78230557Sjimharris * 79230557Sjimharris * @brief This structure defines the fields common to all subjects that 80230557Sjimharris * participate in the observer design pattern 81230557Sjimharris */ 82230557Sjimharristypedef struct SCI_BASE_SUBJECT 83230557Sjimharris{ 84230557Sjimharris struct SCI_BASE_OBSERVER *observer_list; 85230557Sjimharris 86230557Sjimharris} SCI_BASE_SUBJECT_T; 87230557Sjimharris 88230557Sjimharris 89230557Sjimharris/** 90230557Sjimharris * @brief This method acts as the basic constructor for the subject. 91230557Sjimharris * 92230557Sjimharris * @param[in] this_subject This fields specifies the subject being 93230557Sjimharris * constructed. 94230557Sjimharris * 95230557Sjimharris * @return none 96230557Sjimharris */ 97230557Sjimharrisvoid sci_base_subject_construct( 98230557Sjimharris SCI_BASE_SUBJECT_T *this_subject 99230557Sjimharris); 100230557Sjimharris 101230557Sjimharris/** 102230557Sjimharris * @brief This method will call the update method for all 103230557Sjimharris * observers attached to this subject. 104230557Sjimharris * 105230557Sjimharris * @param[in] this_subject This parameter specifies the subject for 106230557Sjimharris * which to notify participating observers. 107230557Sjimharris * 108230557Sjimharris * @return none 109230557Sjimharris */ 110230557Sjimharrisvoid sci_base_subject_notify( 111230557Sjimharris SCI_BASE_SUBJECT_T *this_subject 112230557Sjimharris); 113230557Sjimharris 114230557Sjimharris/** 115230557Sjimharris * @brief This method will add an observer to the subject. 116230557Sjimharris * 117230557Sjimharris * @param[in] this_subject This parameter specifies the subject for which 118230557Sjimharris * an observer is being added. 119230557Sjimharris * @param[in] observer This parameter specifies the observer that wishes 120230557Sjimharris * it listen for notifications for the supplied subject. 121230557Sjimharris * 122230557Sjimharris * @return none 123230557Sjimharris */ 124230557Sjimharrisvoid sci_base_subject_attach_observer( 125230557Sjimharris SCI_BASE_SUBJECT_T *this_subject, 126230557Sjimharris struct SCI_BASE_OBSERVER *observer 127230557Sjimharris); 128230557Sjimharris 129230557Sjimharris/** 130230557Sjimharris * @brief This method will remove the observer from the subject. 131230557Sjimharris * 132230557Sjimharris * @param[in] this_subject 133230557Sjimharris * @param[in] my_observer 134230557Sjimharris * 135230557Sjimharris * @return none 136230557Sjimharris */ 137230557Sjimharrisvoid sci_base_subject_detach_observer( 138230557Sjimharris SCI_BASE_SUBJECT_T *this_subject, 139230557Sjimharris struct SCI_BASE_OBSERVER *my_observer 140230557Sjimharris); 141230557Sjimharris 142230557Sjimharris#else // defined(SCI_LOGGING) 143230557Sjimharris 144230557Sjimharristypedef U8 SCI_BASE_SUBJECT_T; 145230557Sjimharris 146230557Sjimharris#define sci_base_subject_construct 147230557Sjimharris#define sci_base_subject_notify 148230557Sjimharris#define sci_base_subject_attach_observer 149230557Sjimharris#define sci_base_subject_detach_observer 150230557Sjimharris 151230557Sjimharris#endif // defined(SCI_LOGGING) 152230557Sjimharris 153230557Sjimharris#ifdef __cplusplus 154230557Sjimharris} 155230557Sjimharris#endif // __cplusplus 156230557Sjimharris 157230557Sjimharris#endif // _SCI_BASE_SUBJECT_H_ 158