app_mailbox_local.h 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. /* Copyright (c) 2015 Nordic Semiconductor. All Rights Reserved.
  2. *
  3. * The information contained herein is property of Nordic Semiconductor ASA.
  4. * Terms and conditions of usage are described in detail in NORDIC
  5. * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
  6. *
  7. * Licensees are granted free, non-transferable use of the information. NO
  8. * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
  9. * the file.
  10. *
  11. */
  12. /**
  13. * @cond (NODOX)
  14. * @defgroup app_mailbox_internal Auxiliary internal types declarations
  15. * @{
  16. * @ingroup app_mailbox
  17. * @internal
  18. *
  19. * @brief Module for internal usage inside the library only
  20. *
  21. * Some definitions must be included in the header file because
  22. * of the way the library is set up. In this way, the are accessible to the user.
  23. * However, any functions and variables defined here may change at any time
  24. * without a warning, so you should not access them directly.
  25. */
  26. /**
  27. * @brief Mailbox handle used for managing a mailbox queue.
  28. */
  29. typedef struct
  30. {
  31. uint8_t r_idx; /**< Read index for the mailbox queue. */
  32. uint8_t w_idx; /**< Write index for the mailbox queue. */
  33. uint8_t len; /**< Number of elements currently in the mailbox queue. */
  34. app_mailbox_overflow_mode_t mode; /**< Mode of overflow handling. */
  35. } app_mailbox_cb_t;
  36. /** @}
  37. * @endcond
  38. */