| <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>EPTF_MQTT_Transport_Definitions - Massive IoT Test Tools</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!-- |
| if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script> |
| |
| <!-- Generated by Natural Docs, version 1.52 --> |
| <!-- http://www.naturaldocs.org --> |
| |
| <!-- saved from url=(0026)http://www.naturaldocs.org --> |
| |
| |
| |
| |
| <div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="EPTF_MQTT_Transport_Definitions"></a>EPTF_MQTT_Transport_Definitions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the definitions of callback functions for the Applib user API</p><h4 class=CHeading>Module depends on</h4><ul><li><MQTT_v3_1_1_Types></li><li><IPL4asp_Types></li></ul><h4 class=CHeading>Component Diagram</h4><p>(see EPTF_MQTT_Transport_Definitions.components.jpg)</p><h4 class=CHeading>See also</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_Definitions" class=LFile id=link21 onMouseOver="ShowTip(event, 'tt17', 'link21')" onMouseOut="HideTip('tt17')">EPTF_MQTT_LGen_Definitions</a></li><li><a href="#EPTF_MQTT_Transport_User_CT" class=LType id=link22 onMouseOver="ShowTip(event, 'tt16', 'link22')" onMouseOut="HideTip('tt16')">EPTF_MQTT_Transport_User_CT</a></li><li><a href="#EPTF_MQTT_Transport_Provider_CT" class=LType id=link23 onMouseOver="ShowTip(event, 'tt15', 'link23')" onMouseOut="HideTip('tt15')">EPTF_MQTT_Transport_Provider_CT</a></li></ul><h4 class=CHeading>Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>EPTF_MQTT_PDU</td><td class=CDLDescription><a href="#EPTF_MQTT_PDU" class=LType id=link24 onMouseOver="ShowTip(event, 'tt2', 'link24')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> - Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information</td></tr></table><h4 class=CHeading>Callback Function types</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>fcb_EPTF_MQTT_Transport_receiveMessage</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_receiveMessage" class=LType id=link25 onMouseOver="ShowTip(event, 'tt1', 'link25')" onMouseOut="HideTip('tt1')">fcb_EPTF_MQTT_Transport_receiveMessage</a> - Call-back function type for reporting received <a href="#EPTF_MQTT_PDU" class=LType id=link26 onMouseOver="ShowTip(event, 'tt2', 'link26')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> MQTT message</td></tr><tr><td class=CDLEntry>fcb_EPTF_MQTT_Transport_receiveEvent</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_receiveEvent" class=LType id=link27 onMouseOver="ShowTip(event, 'tt3', 'link27')" onMouseOut="HideTip('tt3')">fcb_EPTF_MQTT_Transport_receiveEvent</a> - Call-back function type for reporting received <ASP_Event> MQTT event</td></tr><tr><td class=CDLEntry>fcb_EPTF_MQTT_Transport_sendMessage</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_sendMessage" class=LType id=link28 onMouseOver="ShowTip(event, 'tt4', 'link28')" onMouseOut="HideTip('tt4')">fcb_EPTF_MQTT_Transport_sendMessage</a> - Call-back function type for sending a <a href="#EPTF_MQTT_PDU" class=LType id=link29 onMouseOver="ShowTip(event, 'tt2', 'link29')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> MQTT message</td></tr><tr><td class=CDLEntry>fcb_EPTF_MQTT_Transport_apiRequest</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_apiRequest" class=LType id=link30 onMouseOver="ShowTip(event, 'tt5', 'link30')" onMouseOut="HideTip('tt5')">fcb_EPTF_MQTT_Transport_apiRequest</a> - Call-back function type for sending a <a href="#EPTF_MQTT_Transport_Request" class=LType id=link31 onMouseOver="ShowTip(event, 'tt6', 'link31')" onMouseOut="HideTip('tt6')">EPTF_MQTT_Transport_Request</a> MQTT transport request</td></tr><tr><td class=CDLEntry>fcb_EPTF_MQTT_Transport_apiResponse</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_apiResponse" class=LType id=link32 onMouseOver="ShowTip(event, 'tt7', 'link32')" onMouseOut="HideTip('tt7')">fcb_EPTF_MQTT_Transport_apiResponse</a> - Call-back function type for reporting a <a href="#EPTF_MQTT_Transport_Response" class=LType id=link33 onMouseOver="ShowTip(event, 'tt8', 'link33')" onMouseOut="HideTip('tt8')">EPTF_MQTT_Transport_Response</a> MQTT transport response</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#EPTF_MQTT_Transport_Definitions" >EPTF_MQTT_Transport_Definitions</a></td><td class=SDescription>This module contains the definitions of callback functions for the Applib user API</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#fcb_EPTF_MQTT_Transport_receiveMessage" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">fcb_EPTF_MQTT_Transport_receiveMessage</a></td><td class=SDescription>Call-back function type for reporting received <a href="#EPTF_MQTT_PDU" class=LType id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> MQTT message</td></tr><tr class="SType"><td class=SEntry><a href="#fcb_EPTF_MQTT_Transport_receiveEvent" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">fcb_EPTF_MQTT_Transport_receiveEvent</a></td><td class=SDescription>Call-back function type for reporting received <ASP_Event> MQTT event</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#fcb_EPTF_MQTT_Transport_sendMessage" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">fcb_EPTF_MQTT_Transport_sendMessage</a></td><td class=SDescription>Call-back function type for sending a <a href="#EPTF_MQTT_PDU" class=LType id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> MQTT message</td></tr><tr class="SType"><td class=SEntry><a href="#fcb_EPTF_MQTT_Transport_apiRequest" id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">fcb_EPTF_MQTT_Transport_apiRequest</a></td><td class=SDescription>Call-back function type for sending a <a href="#EPTF_MQTT_Transport_Request" class=LType id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">EPTF_MQTT_Transport_Request</a> MQTT transport request</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#fcb_EPTF_MQTT_Transport_apiResponse" id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">fcb_EPTF_MQTT_Transport_apiResponse</a></td><td class=SDescription>Call-back function type for reporting a <a href="#EPTF_MQTT_Transport_Response" class=LType id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">EPTF_MQTT_Transport_Response</a> MQTT transport response</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_MQTT_PDU" id=link10 onMouseOver="ShowTip(event, 'tt2', 'link10')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a></td><td class=SDescription>Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#EPTF_MQTT_TransportParameters" id=link11 onMouseOver="ShowTip(event, 'tt9', 'link11')" onMouseOut="HideTip('tt9')">EPTF_MQTT_TransportParameters</a></td><td class=SDescription>Transport parameters for MQTT</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_MQTT_Transport_Request" id=link12 onMouseOver="ShowTip(event, 'tt6', 'link12')" onMouseOut="HideTip('tt6')">EPTF_MQTT_Transport_Request</a></td><td class=SDescription>Type for transport request</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#EPTF_MQTT_Transport_RequestParams" id=link13 onMouseOver="ShowTip(event, 'tt10', 'link13')" onMouseOut="HideTip('tt10')">EPTF_MQTT_Transport_RequestParams</a></td><td class=SDescription>Union encapsulating the different transport requests</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_MQTT_Transport_startListening" id=link14 onMouseOver="ShowTip(event, 'tt11', 'link14')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_startListening</a></td><td class=SDescription>Starts a listening socket</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#EPTF_MQTT_Transport_connect" id=link15 onMouseOver="ShowTip(event, 'tt12', 'link15')" onMouseOut="HideTip('tt12')">EPTF_MQTT_Transport_connect</a></td><td class=SDescription>Establishes a connection between the local and remote sockets</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_MQTT_Transport_close" id=link16 onMouseOver="ShowTip(event, 'tt13', 'link16')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_close</a></td><td class=SDescription>Closes the connection</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#EPTF_MQTT_Transport_Response" id=link17 onMouseOver="ShowTip(event, 'tt8', 'link17')" onMouseOut="HideTip('tt8')">EPTF_MQTT_Transport_Response</a></td><td class=SDescription>Type for transport response</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_MQTT_Transport_ResponseParams" id=link18 onMouseOver="ShowTip(event, 'tt14', 'link18')" onMouseOut="HideTip('tt14')">EPTF_MQTT_Transport_ResponseParams</a></td><td class=SDescription>Union encapsulating the responses</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#EPTF_MQTT_Transport_Provider_CT" id=link19 onMouseOver="ShowTip(event, 'tt15', 'link19')" onMouseOut="HideTip('tt15')">EPTF_MQTT_Transport_Provider_CT</a></td><td class=SDescription>Base component type for a MQTT transport realization, declares variables to register the transport user functions</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_MQTT_Transport_User_CT" id=link20 onMouseOver="ShowTip(event, 'tt16', 'link20')" onMouseOut="HideTip('tt16')">EPTF_MQTT_Transport_User_CT</a></td><td class=SDescription>Base component type for a MQTT transport user realization</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="fcb_EPTF_MQTT_Transport_receiveMessage"></a>fcb_EPTF_MQTT_Transport_receiveMessage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_receiveMessage(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Call-back function type for reporting received <a href="#EPTF_MQTT_PDU" class=LType id=link34 onMouseOver="ShowTip(event, 'tt2', 'link34')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> MQTT message</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_message</td><td class=CDLDescription><b>in</b> <a href="#EPTF_MQTT_PDU" class=LType id=link35 onMouseOver="ShowTip(event, 'tt2', 'link35')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> - received MQTT message</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="fcb_EPTF_MQTT_Transport_receiveEvent"></a>fcb_EPTF_MQTT_Transport_receiveEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_receiveEvent(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>ASP_Event </td><td class="PParameter prettyprint " nowrap width=100%>p_event</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Call-back function type for reporting received <ASP_Event> MQTT event</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_event</td><td class=CDLDescription><b>in</b> <ASP_Event> - received MQTT event</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="fcb_EPTF_MQTT_Transport_sendMessage"></a>fcb_EPTF_MQTT_Transport_sendMessage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_sendMessage(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>pl_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Call-back function type for sending a <a href="#EPTF_MQTT_PDU" class=LType id=link36 onMouseOver="ShowTip(event, 'tt2', 'link36')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> MQTT message</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_msg</td><td class=CDLDescription><b>in</b> <a href="#EPTF_MQTT_PDU" class=LType id=link37 onMouseOver="ShowTip(event, 'tt2', 'link37')" onMouseOut="HideTip('tt2')">EPTF_MQTT_PDU</a> - MQTT message to be sent</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="fcb_EPTF_MQTT_Transport_apiRequest"></a>fcb_EPTF_MQTT_Transport_apiRequest</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_apiRequest(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_Transport_Request </td><td class="PParameter prettyprint " nowrap width=100%>pl_req</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Call-back function type for sending a <a href="#EPTF_MQTT_Transport_Request" class=LType id=link38 onMouseOver="ShowTip(event, 'tt6', 'link38')" onMouseOut="HideTip('tt6')">EPTF_MQTT_Transport_Request</a> MQTT transport request</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_req</td><td class=CDLDescription><b>in</b> <a href="#EPTF_MQTT_Transport_Request" class=LType id=link39 onMouseOver="ShowTip(event, 'tt6', 'link39')" onMouseOut="HideTip('tt6')">EPTF_MQTT_Transport_Request</a> - MQTT transport request to be sent</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="fcb_EPTF_MQTT_Transport_apiResponse"></a>fcb_EPTF_MQTT_Transport_apiResponse</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_apiResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_Transport_Response </td><td class="PParameter prettyprint " nowrap width=100%>pl_rsp</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Call-back function type for reporting a <a href="#EPTF_MQTT_Transport_Response" class=LType id=link40 onMouseOver="ShowTip(event, 'tt8', 'link40')" onMouseOut="HideTip('tt8')">EPTF_MQTT_Transport_Response</a> MQTT transport response</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_rsp</td><td class=CDLDescription><b>in</b> <a href="#EPTF_MQTT_Transport_Response" class=LType id=link41 onMouseOver="ShowTip(event, 'tt8', 'link41')" onMouseOut="HideTip('tt8')">EPTF_MQTT_Transport_Response</a> - MQTT transport response to be reported</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_PDU"></a>EPTF_MQTT_PDU</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_PDU</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pdu</td><td class=CDLDescription><MQTT_ReqResp> - MQTT PDU</td></tr><tr><td class=CDLEntry>transportParams</td><td class=CDLDescription><a href="#EPTF_MQTT_TransportParameters" class=LType id=link42 onMouseOver="ShowTip(event, 'tt9', 'link42')" onMouseOut="HideTip('tt9')">EPTF_MQTT_TransportParameters</a> - transport protocol information</td></tr><tr><td class=CDLEntry>sessionIdx</td><td class=CDLDescription><b>integer</b> - session index</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_TransportParameters"></a>EPTF_MQTT_TransportParameters</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_TransportParameters</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Transport parameters for MQTT</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>localAddress</td><td class=CDLDescription><Socket> - local address</td></tr><tr><td class=CDLEntry>remoteAddress</td><td class=CDLDescription><Socket> - remote address</td></tr><tr><td class=CDLEntry>proto</td><td class=CDLDescription><ProtoTuple> - IP transport protocol</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_Request"></a>EPTF_MQTT_Transport_Request</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_Request</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Type for transport request</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sessionIdx</td><td class=CDLDescription><b>integer</b> - session index</td></tr><tr><td class=CDLEntry>expectResponse</td><td class=CDLDescription><b>boolean</b> - set to true if request execution result is expected to be reported back</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription><a href="#EPTF_MQTT_Transport_RequestParams" class=LType id=link43 onMouseOver="ShowTip(event, 'tt10', 'link43')" onMouseOut="HideTip('tt10')">EPTF_MQTT_Transport_RequestParams</a> <b>optional</b> - parameters of the request</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_RequestParams"></a>EPTF_MQTT_Transport_RequestParams</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union EPTF_MQTT_Transport_RequestParams</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Union encapsulating the different transport requests</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>startListening</td><td class=CDLDescription><a href="#EPTF_MQTT_Transport_startListening" class=LType id=link44 onMouseOver="ShowTip(event, 'tt11', 'link44')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_startListening</a> - starts a listening socket</td></tr><tr><td class=CDLEntry>connect_</td><td class=CDLDescription><a href="#EPTF_MQTT_Transport_connect" class=LType id=link45 onMouseOver="ShowTip(event, 'tt12', 'link45')" onMouseOut="HideTip('tt12')">EPTF_MQTT_Transport_connect</a> - connects to the remote address</td></tr><tr><td class=CDLEntry>close</td><td class=CDLDescription><a href="#EPTF_MQTT_Transport_RequestParams" class=LType id=link46 onMouseOver="ShowTip(event, 'tt10', 'link46')" onMouseOut="HideTip('tt10')">EPTF_MQTT_Transport_RequestParams</a> - closes the connection</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_startListening"></a>EPTF_MQTT_Transport_startListening</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_startListening</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Starts a listening socket</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>localAddress</td><td class=CDLDescription><Socket> - local address of the listning socket</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_connect"></a>EPTF_MQTT_Transport_connect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_connect</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Establishes a connection between the local and remote sockets</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>localAddress</td><td class=CDLDescription><Socket> - local address of the connection</td></tr><tr><td class=CDLEntry>remoteAddress</td><td class=CDLDescription><Socket> - remote address of the connection</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_close"></a>EPTF_MQTT_Transport_close</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_close</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Closes the connection</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>localAddress</td><td class=CDLDescription><Socket> - local address of the connection</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_Response"></a>EPTF_MQTT_Transport_Response</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_Response</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Type for transport response</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>succ</td><td class=CDLDescription><b>boolean</b> - result request’s execution</td></tr><tr><td class=CDLEntry>sessionIdx</td><td class=CDLDescription><b>integer</b> - session index</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription><a href="#EPTF_MQTT_Transport_ResponseParams" class=LType id=link47 onMouseOver="ShowTip(event, 'tt14', 'link47')" onMouseOut="HideTip('tt14')">EPTF_MQTT_Transport_ResponseParams</a> <b>optional</b> - parameters of the response</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_ResponseParams"></a>EPTF_MQTT_Transport_ResponseParams</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union EPTF_MQTT_Transport_ResponseParams</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Union encapsulating the responses</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>listening</td><td class=CDLDescription><b>boolean</b> - true if the listening socket was opened succesfully, false otherwise</td></tr><tr><td class=CDLEntry>connectionClose</td><td class=CDLDescription><Socket> - indication of a closed connection with its address</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_Provider_CT"></a>EPTF_MQTT_Transport_Provider_CT</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_MQTT_Transport_Provider_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Base component type for a MQTT transport realization, declares variables to register the transport user functions</p><h4 class=CHeading>Class</h4><p>(see EPTF_MQTT_Transport_Definitions.EPTF_MQTT_Transport_Provider_CT.jpg)</p><h4 class=CHeading>Variables</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vf_EPTF_MQTT_Transport_receiveMessage</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_receiveMessage" class=LType id=link48 onMouseOver="ShowTip(event, 'tt1', 'link48')" onMouseOut="HideTip('tt1')">fcb_EPTF_MQTT_Transport_receiveMessage</a> - Function hook for reporting received messages</td></tr><tr><td class=CDLEntry>vf_EPTF_MQTT_Transport_receiveEvent</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_receiveEvent" class=LType id=link49 onMouseOver="ShowTip(event, 'tt3', 'link49')" onMouseOut="HideTip('tt3')">fcb_EPTF_MQTT_Transport_receiveEvent</a> - Function hook for reporting received events</td></tr><tr><td class=CDLEntry>vf_EPTF_MQTT_Transport_apiResponse</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_apiResponse" class=LType id=link50 onMouseOver="ShowTip(event, 'tt7', 'link50')" onMouseOut="HideTip('tt7')">fcb_EPTF_MQTT_Transport_apiResponse</a> - Function hook for reporting transport API responses</td></tr></table></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_MQTT_Transport_User_CT"></a>EPTF_MQTT_Transport_User_CT</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_MQTT_Transport_User_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Base component type for a MQTT transport user realization</p><h4 class=CHeading>Class</h4><p>(see EPTF_MQTT_Transport_Definitions.EPTF_MQTT_Transport_User_CT.jpg)</p><h4 class=CHeading>Variables</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vf_EPTF_MQTT_Transport_send</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_sendMessage" class=LType id=link51 onMouseOver="ShowTip(event, 'tt4', 'link51')" onMouseOut="HideTip('tt4')">fcb_EPTF_MQTT_Transport_sendMessage</a> - Function hook for reporting received messages</td></tr><tr><td class=CDLEntry>vf_EPTF_MQTT_Transport_apiRequest</td><td class=CDLDescription><a href="#fcb_EPTF_MQTT_Transport_apiRequest" class=LType id=link52 onMouseOver="ShowTip(event, 'tt5', 'link52')" onMouseOut="HideTip('tt5')">fcb_EPTF_MQTT_Transport_apiRequest</a> - Function hook for reporting received events</td></tr></table></div></div></div> |
| |
| </div><!--Content--> |
| |
| |
| |
| <!--START_ND_TOOLTIPS--> |
| <div class=CToolTip id="tt1"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_receiveMessage(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote>Call-back function type for reporting received EPTF_MQTT_PDU MQTT message</div></div><div class=CToolTip id="tt2"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_PDU</td></tr></table></blockquote>Encapsulates a MQTT PDU with the corresponding entity (and FSM) indices and transport information</div></div><div class=CToolTip id="tt3"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_receiveEvent(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>ASP_Event </td><td class="PParameter prettyprint " nowrap width=100%>p_event</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote>Call-back function type for reporting received ASP_Event MQTT event</div></div><div class=CToolTip id="tt4"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_sendMessage(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>pl_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote>Call-back function type for sending a EPTF_MQTT_PDU MQTT message</div></div><div class=CToolTip id="tt5"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_apiRequest(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_Transport_Request </td><td class="PParameter prettyprint " nowrap width=100%>pl_req</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote>Call-back function type for sending a EPTF_MQTT_Transport_Request MQTT transport request</div></div><div class=CToolTip id="tt6"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_Request</td></tr></table></blockquote>Type for transport request</div></div><div class=CToolTip id="tt7"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>type function fcb_EPTF_MQTT_Transport_apiResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_MQTT_Transport_Response </td><td class="PParameter prettyprint " nowrap width=100%>pl_rsp</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on self</td></tr></table></td></tr></table></blockquote>Call-back function type for reporting a EPTF_MQTT_Transport_Response MQTT transport response</div></div><div class=CToolTip id="tt8"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_Response</td></tr></table></blockquote>Type for transport response</div></div><div class=CToolTip id="tt9"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_TransportParameters</td></tr></table></blockquote>Transport parameters for MQTT</div></div><div class=CToolTip id="tt10"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union EPTF_MQTT_Transport_RequestParams</td></tr></table></blockquote>Union encapsulating the different transport requests</div></div><div class=CToolTip id="tt11"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_startListening</td></tr></table></blockquote>Starts a listening socket</div></div><div class=CToolTip id="tt12"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_connect</td></tr></table></blockquote>Establishes a connection between the local and remote sockets</div></div><div class=CToolTip id="tt13"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_MQTT_Transport_close</td></tr></table></blockquote>Closes the connection</div></div><div class=CToolTip id="tt14"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union EPTF_MQTT_Transport_ResponseParams</td></tr></table></blockquote>Union encapsulating the responses</div></div><div class=CToolTip id="tt15"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_MQTT_Transport_Provider_CT</td></tr></table></blockquote>Base component type for a MQTT transport realization, declares variables to register the transport user functions</div></div><div class=CToolTip id="tt16"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_MQTT_Transport_User_CT</td></tr></table></blockquote>Base component type for a MQTT transport user realization</div></div><div class=CToolTip id="tt17"><div class=CFile>This module contains the definitions for the MQTT load generator component</div></div><!--END_ND_TOOLTIPS--> |
| |
| <script language=JavaScript><!-- |
| if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |
