sci_base_subject.h revision 330897 
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 * $FreeBSD: stable/11/sys/dev/isci/scil/sci_base_subject.h 330897 2018-03-14 03:19:51Z eadler $
55 */
56#ifndef _SCI_BASE_SUBJECT_H_
57#define _SCI_BASE_SUBJECT_H_
58
59/**
60 * @file
61 *
62 * @brief This file contains all of the structures, constants, and methods
63 *        common to all subjects object definitions.  A subject is a
64 *        participant in the observer pattern.  A subject represents the
65 *        object being observed.
66 */
67
68#ifdef __cplusplus
69extern "C" {
70#endif // __cplusplus
71
72#include <dev/isci/scil/sci_types.h>
73
74#if defined(SCI_LOGGING)
75
76struct SCI_BASE_OBSERVER;
77
78/**
79 * @struct SCI_BASE_SUBJECT
80 *
81 * @brief This structure defines the fields common to all subjects that
82 *        participate in the observer design pattern
83 */
84typedef struct SCI_BASE_SUBJECT
85{
86   struct SCI_BASE_OBSERVER *observer_list;
87
88} SCI_BASE_SUBJECT_T;
89
90
91/**
92 * @brief This method acts as the basic constructor for the subject.
93 *
94 * @param[in] this_subject This fields specifies the subject being
95 *            constructed.
96 *
97 * @return none
98 */
99void sci_base_subject_construct(
100   SCI_BASE_SUBJECT_T  *this_subject
101);
102
103/**
104 * @brief This method will call the update method for all
105 *        observers attached to this subject.
106 *
107 * @param[in] this_subject This parameter specifies the subject for
108 *            which to notify participating observers.
109 *
110 * @return none
111 */
112void sci_base_subject_notify(
113   SCI_BASE_SUBJECT_T  *this_subject
114);
115
116/**
117 * @brief This method will add an observer to the subject.
118 *
119 * @param[in] this_subject This parameter specifies the subject for which
120 *            an observer is being added.
121 * @param[in] observer This parameter specifies the observer that wishes
122 *            it listen for notifications for the supplied subject.
123 *
124 * @return none
125 */
126void sci_base_subject_attach_observer(
127   SCI_BASE_SUBJECT_T        *this_subject,
128   struct SCI_BASE_OBSERVER  *observer
129);
130
131/**
132 * @brief This method will remove the observer from the subject.
133 *
134 * @param[in] this_subject
135 * @param[in] my_observer
136 *
137 * @return none
138 */
139void sci_base_subject_detach_observer(
140   SCI_BASE_SUBJECT_T        *this_subject,
141   struct SCI_BASE_OBSERVER  *my_observer
142);
143
144#else // defined(SCI_LOGGING)
145
146typedef U8 SCI_BASE_SUBJECT_T;
147
148#define sci_base_subject_construct
149#define sci_base_subject_notify
150#define sci_base_subject_attach_observer
151#define sci_base_subject_detach_observer
152
153#endif // defined(SCI_LOGGING)
154
155#ifdef __cplusplus
156}
157#endif // __cplusplus
158
159#endif // _SCI_BASE_SUBJECT_H_
160