IxNpeMhUnsolicitedCbMgr_p.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  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.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 IxNpeMhUnsolicitedCbMgr_p IxNpeMhUnsolicitedCbMgr_p
  27. *
  28. * @brief The private API for the Unsolicited Callback Manager module.
  29. *
  30. * @{
  31. */
  32. #ifndef IXNPEMHUNSOLICITEDCBMGR_P_H
  33. #define IXNPEMHUNSOLICITEDCBMGR_P_H
  34. #include "IxNpeMh.h"
  35. #include "IxOsalTypes.h"
  36. /*
  37. * #defines for function return types, etc.
  38. */
  39. /*
  40. * Prototypes for interface functions.
  41. */
  42. /**
  43. * @fn void ixNpeMhUnsolicitedCbMgrInitialize (void)
  44. *
  45. * @brief This function initializes the Unsolicited Callback Manager
  46. * module, setting up a callback data structure for each NPE.
  47. *
  48. * @return No return value.
  49. */
  50. void ixNpeMhUnsolicitedCbMgrInitialize (void);
  51. /**
  52. * @fn void ixNpeMhUnsolicitedCbMgrCallbackSave (
  53. IxNpeMhNpeId npeId,
  54. IxNpeMhMessageId unsolicitedMessageId,
  55. IxNpeMhCallback unsolicitedCallback)
  56. *
  57. * @brief This function saves a callback in the specified NPE's callback
  58. * table. If a callback already exists for the specified ID then it will
  59. * be overwritten.
  60. *
  61. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback
  62. * table the callback will be saved.
  63. * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the
  64. * messages that this callback is for.
  65. * @param IxNpeMhCallback unsolicitedCallback (in) - The callback function
  66. * pointer to save.
  67. *
  68. * @return No return value.
  69. */
  70. void ixNpeMhUnsolicitedCbMgrCallbackSave (
  71. IxNpeMhNpeId npeId,
  72. IxNpeMhMessageId unsolicitedMessageId,
  73. IxNpeMhCallback unsolicitedCallback);
  74. /**
  75. * @fn void ixNpeMhUnsolicitedCbMgrCallbackRetrieve (
  76. IxNpeMhNpeId npeId,
  77. IxNpeMhMessageId unsolicitedMessageId,
  78. IxNpeMhCallback *unsolicitedCallback)
  79. *
  80. * @brief This function retrieves the callback for the specified ID from
  81. * the specified NPE's callback table. If no callback is registered for
  82. * the specified ID and NPE then a callback value of NULL will be returned.
  83. *
  84. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback
  85. * table the callback will be retrieved.
  86. * @param IxNpeMhMessageId unsolicitedMessageId (in) - The ID of the
  87. * messages that the callback is for.
  88. * @param IxNpeMhCallback unsolicitedCallback (out) - The callback function
  89. * pointer retrieved.
  90. *
  91. * @return No return value.
  92. */
  93. void ixNpeMhUnsolicitedCbMgrCallbackRetrieve (
  94. IxNpeMhNpeId npeId,
  95. IxNpeMhMessageId unsolicitedMessageId,
  96. IxNpeMhCallback *unsolicitedCallback);
  97. /**
  98. * @fn void ixNpeMhUnsolicitedCbMgrShow (
  99. IxNpeMhNpeId npeId)
  100. *
  101. * @brief This function will display the current state of the Unsolicited
  102. * Callback Manager module.
  103. *
  104. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
  105. * information for.
  106. *
  107. * @return No return value.
  108. */
  109. void ixNpeMhUnsolicitedCbMgrShow (
  110. IxNpeMhNpeId npeId);
  111. /**
  112. * @fn void ixNpeMhUnsolicitedCbMgrShowReset (
  113. IxNpeMhNpeId npeId)
  114. *
  115. * @brief This function will reset the current state of the Unsolicited
  116. * Callback Manager module.
  117. *
  118. * @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
  119. * information for.
  120. *
  121. * @return No return value.
  122. */
  123. void ixNpeMhUnsolicitedCbMgrShowReset (
  124. IxNpeMhNpeId npeId);
  125. #endif /* IXNPEMHUNSOLICITEDCBMGR_P_H */
  126. /**
  127. * @} defgroup IxNpeMhUnsolicitedCbMgr_p
  128. */