Z-Wave Protocol Controller Reference
transport_service.h File Reference
#include "stdint.h"
#include "stdbool.h"
#include "zwave_node_id_definitions.h"
Include dependency graph for transport_service.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define COMMAND_CLASS_TRANSPORT_SERVICE_V2   0x55
 

Typedefs

typedef zwave_node_id_t ts_node_id_t
 
typedef void(* on_transport_service_send_data_complete_t) (uint8_t status, void *user)
 Transport service calls this callback to notify upper layers of completion of transmit of whole payload. More...
 
typedef void(* on_lower_layer_send_data_complete_t) (uint8_t status, void *user)
 This callback is sent to lower layers and should be called when the transmission of what Transport service asked is either success or failure. More...
 
typedef uint8_t(* send_data_t) (ts_node_id_t source, ts_node_id_t dest, const uint8_t *payload, uint16_t payload_len, uint8_t no_of_expected_responses, const on_lower_layer_send_data_complete_t on_lower_layer_send_data_complete)
 Lower layer Send Data function which Transport service should use for transmitting broken down smaller fragments. More...
 
typedef void(* upper_layer_command_handler_t) (ts_node_id_t source, ts_node_id_t dest, const uint8_t *frame, uint16_t frame_len)
 This function is called when transport service is done receiving/stiching the whole data and the data needs to be hanlded by upper layer command handlers. More...
 

Enumerations

enum  receive_type { SINGLECAST , BROADCAST , MULTICAST }
 
enum  transport_service_send_data_return_code_t { TRANSPORT_SERVICE_SEND_SUCCESS , TRANSPORT_SERVICE_SEND_FAILURE , TRANSPORT_SERVICE_BUSY , TRANSPORT_SERVICE_WILL_OVERFLOW }
 

Functions

void transport_service_init (ts_node_id_t my_node_id, const upper_layer_command_handler_t upper_layer_command_handler, const send_data_t send_data)
 Initialize the Transport Service. More...
 
transport_service_send_data_return_code_t transport_service_send_data (ts_node_id_t source, ts_node_id_t dest, const uint8_t *payload, uint16_t payload_len, uint16_t max_frame_len, const on_transport_service_send_data_complete_t on_send_complete)
 Sending a long frame with Transport service. More...
 
bool transport_service_on_frame_received (ts_node_id_t source, ts_node_id_t dest, receive_type rx_type, const uint8_t *frame_data, uint8_t frame_length)
 Transport service RX function. More...