IxNpeMhSolicitedCbMgr_p.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. /**
  2. * @file IxNpeMhSolicitedCbMgr_p.h
  3. *
  4. * @author Intel Corporation
  5. * @date 18 Jan 2002
  6. *
  7. * @brief This file contains the private API for the Solicited Callback
  8. * Manager module.
  9. *
  10. *
  11. * @par
  12. * IXP400 SW Release version 2.0
  13. *
  14. * -- Copyright Notice --
  15. *
  16. * @par
  17. * Copyright 2001-2005, Intel Corporation.
  18. * All rights reserved.
  19. *
  20. * @par
  21. * SPDX-License-Identifier: BSD-3-Clause
  22. * @par
  23. * -- End of Copyright Notice --
  24. */
  25. /**
  26. * @defgroup IxNpeMhSolicitedCbMgr_p IxNpeMhSolicitedCbMgr_p
  27. *
  28. * @brief The private API for the Solicited Callback Manager module.
  29. *
  30. * @{
  31. */
  32. #ifndef IXNPEMHSOLICITEDCBMGR_P_H
  33. #define IXNPEMHSOLICITEDCBMGR_P_H
  34. #include "IxNpeMh.h"
  35. #include "IxOsalTypes.h"
  36. /*
  37. * #defines for function return types, etc.
  38. */
  39. /** Maximum number of solicited callbacks that can be stored in the list */
  40. #define IX_NPEMH_MAX_CALLBACKS (16)
  41. /*
  42. * Prototypes for interface functions.
  43. */
  44. /**
  45. * @fn void ixNpeMhSolicitedCbMgrInitialize (void)
  46. *
  47. * @brief This function initializes the Solicited Callback Manager module,
  48. * setting up a callback data structure for each NPE.
  49. *
  50. * @return No return value.
  51. */
  52. void ixNpeMhSolicitedCbMgrInitialize (void);
  53. /**
  54. * @fn IX_STATUS ixNpeMhSolicitedCbMgrCallbackSave (
  55. IxNpeMhNpeId npeId,
  56. IxNpeMhMessageId solicitedMessageId,
  57. IxNpeMhCallback solicitedCallback)
  58. *
  59. * @brief This function saves a callback in the specified NPE's callback
  60. * list. If the callback list is full the function will fail.
  61. *
  62. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback
  63. * list the callback will be saved.
  64. * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the message
  65. * that this callback is for.
  66. * @param IxNpeMhCallback solicitedCallback (in) - The callback function
  67. * pointer to save.
  68. *
  69. * @return The function returns a status indicating success or failure.
  70. */
  71. IX_STATUS ixNpeMhSolicitedCbMgrCallbackSave (
  72. IxNpeMhNpeId npeId,
  73. IxNpeMhMessageId solicitedMessageId,
  74. IxNpeMhCallback solicitedCallback);
  75. /**
  76. * @fn void ixNpeMhSolicitedCbMgrCallbackRetrieve (
  77. IxNpeMhNpeId npeId,
  78. IxNpeMhMessageId solicitedMessageId,
  79. IxNpeMhCallback *solicitedCallback)
  80. *
  81. * @brief This function retrieves the first ID-matching callback from the
  82. * specified NPE's callback list. If no matching callback can be found the
  83. * function will fail.
  84. *
  85. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback
  86. * list the callback will be retrieved.
  87. * @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the message
  88. * that the callback is for.
  89. * @param IxNpeMhCallback solicitedCallback (out) - The callback function
  90. * pointer retrieved.
  91. *
  92. * @return No return value.
  93. */
  94. void ixNpeMhSolicitedCbMgrCallbackRetrieve (
  95. IxNpeMhNpeId npeId,
  96. IxNpeMhMessageId solicitedMessageId,
  97. IxNpeMhCallback *solicitedCallback);
  98. /**
  99. * @fn void ixNpeMhSolicitedCbMgrShow (
  100. IxNpeMhNpeId npeId)
  101. *
  102. * @brief This function will display the current state of the Solicited
  103. * Callback Manager module.
  104. *
  105. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
  106. * information for.
  107. *
  108. * @return No return value.
  109. */
  110. void ixNpeMhSolicitedCbMgrShow (
  111. IxNpeMhNpeId npeId);
  112. /**
  113. * @fn void ixNpeMhSolicitedCbMgrShowReset (
  114. IxNpeMhNpeId npeId)
  115. *
  116. * @brief This function will reset the current state of the Solicited
  117. * Callback Manager module.
  118. *
  119. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
  120. * information for.
  121. *
  122. * @return No return value.
  123. */
  124. void ixNpeMhSolicitedCbMgrShowReset (
  125. IxNpeMhNpeId npeId);
  126. #endif /* IXNPEMHSOLICITEDCBMGR_P_H */
  127. /**
  128. * @} defgroup IxNpeMhSolicitedCbMgr_p
  129. */