1 | /** |
---|
2 | * @file IxNpeMhUnsolicitedCbMgr_p.h |
---|
3 | * |
---|
4 | * @author Intel Corporation |
---|
5 | * @date 18 Jan 2002 |
---|
6 | * |
---|
7 | * @brief This file contains the private API for the Unsolicited Callback |
---|
8 | * Manager module. |
---|
9 | * |
---|
10 | * |
---|
11 | * @par |
---|
12 | * IXP400 SW Release version 2.3 |
---|
13 | * |
---|
14 | * -- Copyright Notice -- |
---|
15 | * |
---|
16 | * @par |
---|
17 | * Copyright (c) 2001-2005, Intel Corporation. |
---|
18 | * All rights reserved. |
---|
19 | * |
---|
20 | * @par |
---|
21 | * Redistribution and use in source and binary forms, with or without |
---|
22 | * modification, are permitted provided that the following conditions |
---|
23 | * are met: |
---|
24 | * 1. Redistributions of source code must retain the above copyright |
---|
25 | * notice, this list of conditions and the following disclaimer. |
---|
26 | * 2. Redistributions in binary form must reproduce the above copyright |
---|
27 | * notice, this list of conditions and the following disclaimer in the |
---|
28 | * documentation and/or other materials provided with the distribution. |
---|
29 | * 3. Neither the name of the Intel Corporation nor the names of its contributors |
---|
30 | * may be used to endorse or promote products derived from this software |
---|
31 | * without specific prior written permission. |
---|
32 | * |
---|
33 | * |
---|
34 | * @par |
---|
35 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' |
---|
36 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
37 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
38 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE |
---|
39 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
---|
40 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
---|
41 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
---|
42 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
---|
43 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
---|
44 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
---|
45 | * SUCH DAMAGE. |
---|
46 | * |
---|
47 | * |
---|
48 | * @par |
---|
49 | * -- End of Copyright Notice -- |
---|
50 | */ |
---|
51 | |
---|
52 | /** |
---|
53 | * @defgroup IxNpeMhUnsolicitedCbMgr_p IxNpeMhUnsolicitedCbMgr_p |
---|
54 | * |
---|
55 | * @brief The private API for the Unsolicited Callback Manager module. |
---|
56 | * |
---|
57 | * @{ |
---|
58 | */ |
---|
59 | |
---|
60 | #ifndef IXNPEMHUNSOLICITEDCBMGR_P_H |
---|
61 | #define IXNPEMHUNSOLICITEDCBMGR_P_H |
---|
62 | |
---|
63 | #include "IxNpeMh.h" |
---|
64 | #include "IxOsalTypes.h" |
---|
65 | |
---|
66 | /* |
---|
67 | * #defines for function return types, etc. |
---|
68 | */ |
---|
69 | |
---|
70 | /* |
---|
71 | * Prototypes for interface functions. |
---|
72 | */ |
---|
73 | |
---|
74 | /** |
---|
75 | * @fn void ixNpeMhUnsolicitedCbMgrInitialize (void) |
---|
76 | * |
---|
77 | * @brief This function initializes the Unsolicited Callback Manager |
---|
78 | * module, setting up a callback data structure for each NPE. |
---|
79 | * |
---|
80 | * @return No return value. |
---|
81 | */ |
---|
82 | |
---|
83 | void ixNpeMhUnsolicitedCbMgrInitialize (void); |
---|
84 | |
---|
85 | /** |
---|
86 | * @fn void ixNpeMhUnsolicitedCbMgrUninitialize (void) |
---|
87 | * |
---|
88 | * @brief This function uninitializes the Unsolicited Callback Manager |
---|
89 | * module. |
---|
90 | * |
---|
91 | * @return No return value. |
---|
92 | */ |
---|
93 | |
---|
94 | void ixNpeMhUnsolicitedCbMgrUninitialize (void); |
---|
95 | |
---|
96 | /** |
---|
97 | * @fn void ixNpeMhUnsolicitedCbMgrCallbackSave ( |
---|
98 | IxNpeMhNpeId npeId, |
---|
99 | IxNpeMhMessageId unsolicitedMessageId, |
---|
100 | IxNpeMhCallback unsolicitedCallback) |
---|
101 | * |
---|
102 | * @brief This function saves a callback in the specified NPE's callback |
---|
103 | * table. If a callback already exists for the specified ID then it will |
---|
104 | * be overwritten. |
---|
105 | * |
---|
106 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback |
---|
107 | * table the callback will be saved. |
---|
108 | * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the |
---|
109 | * messages that this callback is for. |
---|
110 | * @param IxNpeMhCallback unsolicitedCallback (in) - The callback function |
---|
111 | * pointer to save. |
---|
112 | * |
---|
113 | * @return No return value. |
---|
114 | */ |
---|
115 | |
---|
116 | void ixNpeMhUnsolicitedCbMgrCallbackSave ( |
---|
117 | IxNpeMhNpeId npeId, |
---|
118 | IxNpeMhMessageId unsolicitedMessageId, |
---|
119 | IxNpeMhCallback unsolicitedCallback); |
---|
120 | |
---|
121 | /** |
---|
122 | * @fn void ixNpeMhUnsolicitedCbMgrCallbackRetrieve ( |
---|
123 | IxNpeMhNpeId npeId, |
---|
124 | IxNpeMhMessageId unsolicitedMessageId, |
---|
125 | IxNpeMhCallback *unsolicitedCallback) |
---|
126 | * |
---|
127 | * @brief This function retrieves the callback for the specified ID from |
---|
128 | * the specified NPE's callback table. If no callback is registered for |
---|
129 | * the specified ID and NPE then a callback value of NULL will be returned. |
---|
130 | * |
---|
131 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback |
---|
132 | * table the callback will be retrieved. |
---|
133 | * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the |
---|
134 | * messages that the callback is for. |
---|
135 | * @param IxNpeMhCallback unsolicitedCallback (out) - The callback function |
---|
136 | * pointer retrieved. |
---|
137 | * |
---|
138 | * @return No return value. |
---|
139 | */ |
---|
140 | |
---|
141 | void ixNpeMhUnsolicitedCbMgrCallbackRetrieve ( |
---|
142 | IxNpeMhNpeId npeId, |
---|
143 | IxNpeMhMessageId unsolicitedMessageId, |
---|
144 | IxNpeMhCallback *unsolicitedCallback); |
---|
145 | |
---|
146 | /** |
---|
147 | * @fn void ixNpeMhUnsolicitedCbMgrShow ( |
---|
148 | IxNpeMhNpeId npeId) |
---|
149 | * |
---|
150 | * @brief This function will display the current state of the Unsolicited |
---|
151 | * Callback Manager module. |
---|
152 | * |
---|
153 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state |
---|
154 | * information for. |
---|
155 | * |
---|
156 | * @return No return value. |
---|
157 | */ |
---|
158 | |
---|
159 | void ixNpeMhUnsolicitedCbMgrShow ( |
---|
160 | IxNpeMhNpeId npeId); |
---|
161 | |
---|
162 | /** |
---|
163 | * @fn void ixNpeMhUnsolicitedCbMgrShowReset ( |
---|
164 | IxNpeMhNpeId npeId) |
---|
165 | * |
---|
166 | * @brief This function will reset the current state of the Unsolicited |
---|
167 | * Callback Manager module. |
---|
168 | * |
---|
169 | * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state |
---|
170 | * information for. |
---|
171 | * |
---|
172 | * @return No return value. |
---|
173 | */ |
---|
174 | |
---|
175 | void ixNpeMhUnsolicitedCbMgrShowReset ( |
---|
176 | IxNpeMhNpeId npeId); |
---|
177 | |
---|
178 | #endif /* IXNPEMHUNSOLICITEDCBMGR_P_H */ |
---|
179 | |
---|
180 | /** |
---|
181 | * @} defgroup IxNpeMhUnsolicitedCbMgr_p |
---|
182 | */ |
---|