ser_conn_event_encoder.h 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. /* Copyright (c) 2014 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. * @addtogroup ser_conn Connectivity application code
  14. * @ingroup ble_sdk_lib_serialization
  15. */
  16. /** @file
  17. *
  18. * @defgroup ser_event_encoder Events encoder in the connectivity chip
  19. * @{
  20. * @ingroup ser_conn
  21. *
  22. * @brief Events encoder for BLE SoftDevice.
  23. *
  24. * @details This file contains declaration of common function used for serializing BLE SoftDevice
  25. * events.
  26. *
  27. */
  28. #ifndef SER_CONN_EVENT_ENCODER_H__
  29. #define SER_CONN_EVENT_ENCODER_H__
  30. #include <stdint.h>
  31. /**@brief A function for encoding a @ref ble_evt_t. The function passes the serialized byte stream
  32. * to the transport layer after encoding.
  33. *
  34. * @details The function is called by the application scheduler to process an event previously
  35. * pulled from BLE SoftDevice.
  36. * The function creates a new packet, calls an appropriate event encoder and sends the
  37. * packet to an Application Chip.
  38. *
  39. * @param[in] p_event_data Pointer to event data of type @ref ble_evt_t.
  40. * @param[in] event_size Event data size.
  41. */
  42. void ser_conn_ble_event_encoder(void * p_event_data, uint16_t event_size);
  43. #endif /* SER_CONN_EVENT_ENCODER_H__ */
  44. /** @} */