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