EPTF_MQTT_Transport_Definitions
Purpose
This module contains the definitions of callback functions for the Applib user API
Module depends on
- <MQTT_v3_1_1_Types>
- <IPL4asp_Types>
Component Diagram
See also
Type
| EPTF_MQTT_PDU | EPTF_MQTT_PDU - Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information |
Callback Function types
| fcb_EPTF_MQTT_Transport_receiveMessage | fcb_EPTF_MQTT_Transport_receiveMessage - Call-back function type for reporting received EPTF_MQTT_PDU MQTT message |
| fcb_EPTF_MQTT_Transport_receiveEvent | fcb_EPTF_MQTT_Transport_receiveEvent - Call-back function type for reporting received <ASP_Event> MQTT event |
| fcb_EPTF_MQTT_Transport_sendMessage | fcb_EPTF_MQTT_Transport_sendMessage - Call-back function type for sending a EPTF_MQTT_PDU MQTT message |
| fcb_EPTF_MQTT_Transport_apiRequest | fcb_EPTF_MQTT_Transport_apiRequest - Call-back function type for sending a EPTF_MQTT_Transport_Request MQTT transport request |
| fcb_EPTF_MQTT_Transport_apiResponse | fcb_EPTF_MQTT_Transport_apiResponse - Call-back function type for reporting a EPTF_MQTT_Transport_Response MQTT transport response |
Summary
| EPTF_MQTT_Transport_Definitions | This module contains the definitions of callback functions for the Applib user API |
| fcb_EPTF_MQTT_Transport_receiveMessage | Call-back function type for reporting received EPTF_MQTT_PDU MQTT message |
| fcb_EPTF_MQTT_Transport_receiveEvent | Call-back function type for reporting received <ASP_Event> MQTT event |
| fcb_EPTF_MQTT_Transport_sendMessage | Call-back function type for sending a EPTF_MQTT_PDU MQTT message |
| fcb_EPTF_MQTT_Transport_apiRequest | Call-back function type for sending a EPTF_MQTT_Transport_Request MQTT transport request |
| fcb_EPTF_MQTT_Transport_apiResponse | Call-back function type for reporting a EPTF_MQTT_Transport_Response MQTT transport response |
| EPTF_MQTT_PDU | Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information |
| EPTF_MQTT_TransportParameters | Transport parameters for MQTT |
| EPTF_MQTT_Transport_Request | Type for transport request |
| EPTF_MQTT_Transport_RequestParams | Union encapsulating the different transport requests |
| EPTF_MQTT_Transport_startListening | Starts a listening socket |
| EPTF_MQTT_Transport_connect | Establishes a connection between the local and remote sockets |
| EPTF_MQTT_Transport_close | Closes the connection |
| EPTF_MQTT_Transport_Response | Type for transport response |
| EPTF_MQTT_Transport_ResponseParams | Union encapsulating the responses |
| EPTF_MQTT_Transport_Provider_CT | Base component type for a MQTT transport realization, declares variables to register the transport user functions |
| EPTF_MQTT_Transport_User_CT | Base component type for a MQTT transport user realization |
fcb_EPTF_MQTT_Transport_receiveMessage
type function fcb_EPTF_MQTT_Transport_receiveMessage( in EPTF_MQTT_PDU pl_message ) runs on self
Purpose
Call-back function type for reporting received EPTF_MQTT_PDU MQTT message
Parameters
| pl_message | in EPTF_MQTT_PDU - received MQTT message |
fcb_EPTF_MQTT_Transport_sendMessage
type function fcb_EPTF_MQTT_Transport_sendMessage( in EPTF_MQTT_PDU pl_msg ) runs on self
Purpose
Call-back function type for sending a EPTF_MQTT_PDU MQTT message
Parameters
| pl_msg | in EPTF_MQTT_PDU - MQTT message to be sent |
fcb_EPTF_MQTT_Transport_apiRequest
type function fcb_EPTF_MQTT_Transport_apiRequest( in EPTF_MQTT_Transport_Request pl_req ) runs on self
Purpose
Call-back function type for sending a EPTF_MQTT_Transport_Request MQTT transport request
Parameters
| pl_req | in EPTF_MQTT_Transport_Request - MQTT transport request to be sent |
fcb_EPTF_MQTT_Transport_apiResponse
type function fcb_EPTF_MQTT_Transport_apiResponse( in EPTF_MQTT_Transport_Response pl_rsp ) runs on self
Purpose
Call-back function type for reporting a EPTF_MQTT_Transport_Response MQTT transport response
Parameters
| pl_rsp | in EPTF_MQTT_Transport_Response - MQTT transport response to be reported |
EPTF_MQTT_PDU
type record EPTF_MQTT_PDU
Purpose
Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information
Parameters
| pdu | <MQTT_ReqResp> - MQTT PDU |
| transportParams | EPTF_MQTT_TransportParameters - transport protocol information |
| sessionIdx | integer - session index |
EPTF_MQTT_Transport_Request
type record EPTF_MQTT_Transport_Request
Purpose
Type for transport request
Elements
| sessionIdx | integer - session index |
| expectResponse | boolean - set to true if request execution result is expected to be reported back |
| params | EPTF_MQTT_Transport_RequestParams optional - parameters of the request |
EPTF_MQTT_Transport_RequestParams
type union EPTF_MQTT_Transport_RequestParams
Purpose
Union encapsulating the different transport requests
Elements
| startListening | EPTF_MQTT_Transport_startListening - starts a listening socket |
| connect_ | EPTF_MQTT_Transport_connect - connects to the remote address |
| close | EPTF_MQTT_Transport_RequestParams - closes the connection |
EPTF_MQTT_Transport_Response
type record EPTF_MQTT_Transport_Response
Purpose
Type for transport response
Parameters
| succ | boolean - result request’s execution |
| sessionIdx | integer - session index |
| params | EPTF_MQTT_Transport_ResponseParams optional - parameters of the response |
EPTF_MQTT_Transport_Provider_CT
type component EPTF_MQTT_Transport_Provider_CT
Purpose
Base component type for a MQTT transport realization, declares variables to register the transport user functions
Class
Variables
| vf_EPTF_MQTT_Transport_receiveMessage | fcb_EPTF_MQTT_Transport_receiveMessage - Function hook for reporting received messages |
| vf_EPTF_MQTT_Transport_receiveEvent | fcb_EPTF_MQTT_Transport_receiveEvent - Function hook for reporting received events |
| vf_EPTF_MQTT_Transport_apiResponse | fcb_EPTF_MQTT_Transport_apiResponse - Function hook for reporting transport API responses |
EPTF_MQTT_Transport_User_CT
type component EPTF_MQTT_Transport_User_CT
Purpose
Base component type for a MQTT transport user realization
Class
Variables
| vf_EPTF_MQTT_Transport_send | fcb_EPTF_MQTT_Transport_sendMessage - Function hook for reporting received messages |
| vf_EPTF_MQTT_Transport_apiRequest | fcb_EPTF_MQTT_Transport_apiRequest - Function hook for reporting received events |