2 * @file IxNpeMhUnsolicitedCbMgr_p.h
4 * @author Intel Corporation
7 * @brief This file contains the private API for the Unsolicited Callback
12 * IXP400 SW Release version 2.0
14 * -- Copyright Notice --
17 * Copyright 2001-2005, Intel Corporation.
18 * All rights reserved.
21 * SPDX-License-Identifier: BSD-3-Clause
23 * -- End of Copyright Notice --
27 * @defgroup IxNpeMhUnsolicitedCbMgr_p IxNpeMhUnsolicitedCbMgr_p
29 * @brief The private API for the Unsolicited Callback Manager module.
34 #ifndef IXNPEMHUNSOLICITEDCBMGR_P_H
35 #define IXNPEMHUNSOLICITEDCBMGR_P_H
38 #include "IxOsalTypes.h"
41 * #defines for function return types, etc.
45 * Prototypes for interface functions.
49 * @fn void ixNpeMhUnsolicitedCbMgrInitialize (void)
51 * @brief This function initializes the Unsolicited Callback Manager
52 * module, setting up a callback data structure for each NPE.
54 * @return No return value.
57 void ixNpeMhUnsolicitedCbMgrInitialize (void);
60 * @fn void ixNpeMhUnsolicitedCbMgrCallbackSave (
62 IxNpeMhMessageId unsolicitedMessageId,
63 IxNpeMhCallback unsolicitedCallback)
65 * @brief This function saves a callback in the specified NPE's callback
66 * table. If a callback already exists for the specified ID then it will
69 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback
70 * table the callback will be saved.
71 * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the
72 * messages that this callback is for.
73 * @param IxNpeMhCallback unsolicitedCallback (in) - The callback function
76 * @return No return value.
79 void ixNpeMhUnsolicitedCbMgrCallbackSave (
81 IxNpeMhMessageId unsolicitedMessageId,
82 IxNpeMhCallback unsolicitedCallback);
85 * @fn void ixNpeMhUnsolicitedCbMgrCallbackRetrieve (
87 IxNpeMhMessageId unsolicitedMessageId,
88 IxNpeMhCallback *unsolicitedCallback)
90 * @brief This function retrieves the callback for the specified ID from
91 * the specified NPE's callback table. If no callback is registered for
92 * the specified ID and NPE then a callback value of NULL will be returned.
94 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback
95 * table the callback will be retrieved.
96 * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the
97 * messages that the callback is for.
98 * @param IxNpeMhCallback unsolicitedCallback (out) - The callback function
101 * @return No return value.
104 void ixNpeMhUnsolicitedCbMgrCallbackRetrieve (
106 IxNpeMhMessageId unsolicitedMessageId,
107 IxNpeMhCallback *unsolicitedCallback);
110 * @fn void ixNpeMhUnsolicitedCbMgrShow (
113 * @brief This function will display the current state of the Unsolicited
114 * Callback Manager module.
116 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
119 * @return No return value.
122 void ixNpeMhUnsolicitedCbMgrShow (
126 * @fn void ixNpeMhUnsolicitedCbMgrShowReset (
129 * @brief This function will reset the current state of the Unsolicited
130 * Callback Manager module.
132 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
135 * @return No return value.
138 void ixNpeMhUnsolicitedCbMgrShowReset (
141 #endif /* IXNPEMHUNSOLICITEDCBMGR_P_H */
144 * @} defgroup IxNpeMhUnsolicitedCbMgr_p