2 * @file IxNpeMhSolicitedCbMgr_p.h
4 * @author Intel Corporation
7 * @brief This file contains the private API for the Solicited 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 IxNpeMhSolicitedCbMgr_p IxNpeMhSolicitedCbMgr_p
29 * @brief The private API for the Solicited Callback Manager module.
34 #ifndef IXNPEMHSOLICITEDCBMGR_P_H
35 #define IXNPEMHSOLICITEDCBMGR_P_H
38 #include "IxOsalTypes.h"
41 * #defines for function return types, etc.
44 /** Maximum number of solicited callbacks that can be stored in the list */
45 #define IX_NPEMH_MAX_CALLBACKS (16)
48 * Prototypes for interface functions.
52 * @fn void ixNpeMhSolicitedCbMgrInitialize (void)
54 * @brief This function initializes the Solicited Callback Manager module,
55 * setting up a callback data structure for each NPE.
57 * @return No return value.
60 void ixNpeMhSolicitedCbMgrInitialize (void);
63 * @fn IX_STATUS ixNpeMhSolicitedCbMgrCallbackSave (
65 IxNpeMhMessageId solicitedMessageId,
66 IxNpeMhCallback solicitedCallback)
68 * @brief This function saves a callback in the specified NPE's callback
69 * list. If the callback list is full the function will fail.
71 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback
72 * list the callback will be saved.
73 * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the message
74 * that this callback is for.
75 * @param IxNpeMhCallback solicitedCallback (in) - The callback function
78 * @return The function returns a status indicating success or failure.
81 IX_STATUS ixNpeMhSolicitedCbMgrCallbackSave (
83 IxNpeMhMessageId solicitedMessageId,
84 IxNpeMhCallback solicitedCallback);
87 * @fn void ixNpeMhSolicitedCbMgrCallbackRetrieve (
89 IxNpeMhMessageId solicitedMessageId,
90 IxNpeMhCallback *solicitedCallback)
92 * @brief This function retrieves the first ID-matching callback from the
93 * specified NPE's callback list. If no matching callback can be found the
96 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback
97 * list the callback will be retrieved.
98 * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the message
99 * that the callback is for.
100 * @param IxNpeMhCallback solicitedCallback (out) - The callback function
103 * @return No return value.
106 void ixNpeMhSolicitedCbMgrCallbackRetrieve (
108 IxNpeMhMessageId solicitedMessageId,
109 IxNpeMhCallback *solicitedCallback);
112 * @fn void ixNpeMhSolicitedCbMgrShow (
115 * @brief This function will display the current state of the Solicited
116 * Callback Manager module.
118 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
121 * @return No return value.
124 void ixNpeMhSolicitedCbMgrShow (
128 * @fn void ixNpeMhSolicitedCbMgrShowReset (
131 * @brief This function will reset the current state of the Solicited
132 * Callback Manager module.
134 * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
137 * @return No return value.
140 void ixNpeMhSolicitedCbMgrShowReset (
143 #endif /* IXNPEMHSOLICITEDCBMGR_P_H */
146 * @} defgroup IxNpeMhSolicitedCbMgr_p