zwave_tx_queue.hpp

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAVE_TX_QUEUE_HPP
#define ZWAVE_TX_QUEUE_HPP
 
// Includes from this component
#include "zwave_tx.h"
 
// Includes from other components
#include "sl_status.h"
 
// Contiki includes
#include "sys/etimer.h"
 
#include "priority_queue.hpp"
 
typedef struct zwave_tx_queue_element {
  uint8_t data[ZWAVE_MAX_FRAME_SIZE];
  uint16_t data_length;
  zwapi_tx_report_t send_data_tx_status;
  zwave_tx_options_t options;
  zwave_controller_connection_info_t connection_info;
  zwave_tx_session_id_t zwave_tx_session_id;
  // if it should still be sent.
  clock_time_t queue_timestamp;
  clock_time_t transmission_timestamp;
  clock_time_t transmission_time;
  on_zwave_tx_send_data_complete_t callback_function;
  void *user;
  uint8_t send_data_status;
} zwave_tx_queue_element_t;
 
struct queue_element_qos_compare {
  bool operator()(const zwave_tx_queue_element_t &lhs,
                  const zwave_tx_queue_element_t &rhs) const
  {
    return lhs.options.qos_priority > rhs.options.qos_priority;
  }
};
 
class zwave_tx_queue
{
  private:
  // Global variable used to get new session IDs.
  uint32_t zwave_tx_session_id_counter = 0;
 
  public:
  sl_status_t enqueue(const zwave_tx_queue_element_t &new_element,
                      zwave_tx_session_id_t *user_session_id);
 
  sl_status_t pop(const zwave_tx_session_id_t session_id);
 
  zwave_tx_queue_element_t *first_in_queue();
 
  void clear();
 
  bool empty() const;
 
  int size() const noexcept;
 
  // Getter functions
 
  sl_status_t get_by_id(zwave_tx_queue_element_t *element,
                        const zwave_tx_session_id_t session_id) const;
 
  bool contains(const zwave_tx_session_id_t session_id) const;
  sl_status_t
    get_highest_priority_child(zwave_tx_queue_element_t *element,
                               const zwave_tx_session_id_t session_id) const;
 
  // Setter functions
 
  sl_status_t set_transmissions_results(const zwave_tx_session_id_t session_id,
                                        uint8_t status,
                                        zwapi_tx_report_t *tx_status);
 
  sl_status_t
    decrement_expected_responses(const zwave_tx_session_id_t session_id);
 
  uint8_t get_number_of_responses(const zwave_tx_session_id_t session_id);
 
  const uint8_t *get_frame(const zwave_tx_session_id_t session_id);
 
  uint16_t get_frame_length(const zwave_tx_session_id_t session_id);
 
  sl_status_t
    set_transmission_timestamp(const zwave_tx_session_id_t session_id);
 
  sl_status_t
    reset_transmission_timestamp(const zwave_tx_session_id_t session_id);
 
  sl_status_t disable_fasttack(const zwave_tx_session_id_t session_id);
 
  bool zwave_tx_has_frames_for_node(const zwave_node_id_t node_id);
 
  // Print functions
 
  void log(bool log_messages_payload) const;
 
  void log_element(const zwave_tx_session_id_t session_id,
                   bool log_frame_payload) const;
 
  void simple_log(zwave_tx_queue_element_t *e) const;
 
  private:
  using queue_iterator = priority_queue<zwave_tx_queue_element_t,
                                        ZWAVE_TX_QUEUE_BUFFER_SIZE,
                                        queue_element_qos_compare>::iterator;
  using const_queue_iterator
    = priority_queue<zwave_tx_queue_element_t,
                     ZWAVE_TX_QUEUE_BUFFER_SIZE,
                     queue_element_qos_compare>::const_iterator;
 
  queue_iterator find(const zwave_tx_session_id_t key);
  const_queue_iterator find(const zwave_tx_session_id_t key) const;
 
  priority_queue<zwave_tx_queue_element_t,
                 ZWAVE_TX_QUEUE_BUFFER_SIZE,
                 queue_element_qos_compare>
    queue;
};
 
#endif  // ZWAVE_TX_QUEUE_HPP