| <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>EPTF_MQTT_LocalTransport_Functions - 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_LocalTransport_Functions"></a>EPTF_MQTT_LocalTransport_Functions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the functions of the MQTT local transport component</p><h4 class=CHeading>See also</h4><p><a href="EPTF_MQTT_LocalTransport_Definitions-ttcn.html#EPTF_MQTT_LocalTransport_Definitions" class=LFile id=link27 onMouseOver="ShowTip(event, 'tt27', 'link27')" onMouseOut="HideTip('tt27')">EPTF_MQTT_LocalTransport_Definitions</a></p><!--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_LocalTransport_Functions" >EPTF_MQTT_LocalTransport_Functions</a></td><td class=SDescription>This module contains the functions of the MQTT local transport component</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_init" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">f_EPTF_MQTT_LocalTransport_init</a></td><td class=SDescription>The main initialization function of the <EPTF_MQTT_LocalTransport_CT> component type</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_initLogging" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">f_EPTF_MQTT_LocalTransport_initLogging</a></td><td class=SDescription>Initializing CLL’s logging feature on the <EPTF_MQTT_LocalTransport_CT> component type</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_cleanup" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">f_EPTF_MQTT_LocalTransport_cleanup</a></td><td class=SDescription>The main clean up function for the <EPTF_MQTT_LocalTransport_CT> component type</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_IPL4asp_handleEvent" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">f_EPTF_MQTT_IPL4asp_handleEvent</a></td><td class=SDescription>Handler function to be registered into the IPL4 transport layer <EPTF_CLL_TransportIPL4_Functions>. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_IPL4asp_handleMessage" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">f_EPTF_MQTT_IPL4asp_handleMessage</a></td><td class=SDescription>Handler function to be regisitered into the IPL4 transport layer <EPTF_CLL_TransportIPL4_Functions>. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_send" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">f_EPTF_MQTT_LocalTransport_send</a></td><td class=SDescription>Function to send out a <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">EPTF_MQTT_PDU</a> message using the local transport. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_transportApiRequest" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">f_EPTF_MQTT_LocalTransport_transportApiRequest</a></td><td class=SDescription>Function to handle incoming transport API requests</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_sendApiResponse" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">f_EPTF_MQTT_LocalTransport_sendApiResponse</a></td><td class=SDescription>Function to handle incoming transport API requests</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_startListening" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">f_EPTF_MQTT_LocalTransport_startListening</a></td><td class=SDescription>Start listening on a local TCP socket and store its data and state in socketDB</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_connect" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">f_EPTF_MQTT_LocalTransport_connect</a></td><td class=SDescription>Open a TCP connection and store its data and state in socketDB</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_close" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">f_EPTF_MQTT_LocalTransport_close</a></td><td class=SDescription>Close a TCP connection and remove its entry from the socketDB</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_IPL4_send" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">f_EPTF_MQTT_LocalTransport_IPL4_send</a></td><td class=SDescription>Send a message and add 1 message and its length to MQTT transport stats variable</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_init" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">f_EPTF_MQTT_LocalTransport_socketDB_init</a></td><td class=SDescription>Initializes the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_cleanUp" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">f_EPTF_MQTT_LocalTransport_socketDB_cleanUp</a></td><td class=SDescription>Cleans up the reserved resources of the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_add" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">f_EPTF_MQTT_LocalTransport_socketDB_add</a></td><td class=SDescription>Adds a new element to the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_lookUp" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">f_EPTF_MQTT_LocalTransport_socketDB_lookUp</a></td><td class=SDescription>Gets the index of an <SocketEntry> element in <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database based on its socket data</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_lookUp_connId" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">f_EPTF_MQTT_LocalTransport_socketDB_lookUp_connId</a></td><td class=SDescription>Gets the index of an <SocketEntry> element in <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database based on its connection id</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_get" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">f_EPTF_MQTT_LocalTransport_socketDB_get</a></td><td class=SDescription>Retrieves an element from the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LocalTransport_socketDB_remove" id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')">f_EPTF_MQTT_LocalTransport_socketDB_remove</a></td><td class=SDescription>Removes an element from the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database and frees up its reserved resources</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_Socket2String" id=link21 onMouseOver="ShowTip(event, 'tt21', 'link21')" onMouseOut="HideTip('tt21')">f_EPTF_MQTT_Socket2String</a></td><td class=SDescription>Converts socket data from <Socket> type to the format “<hostname>:<port number>”</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_Transport_Logging_VERBOSE" id=link22 onMouseOver="ShowTip(event, 'tt22', 'link22')" onMouseOut="HideTip('tt22')">f_MQTT_Transport_Logging_VERBOSE</a></td><td class=SDescription>Logging functions for the VERBOSE log level</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_Transport_Logging_DEBUG" id=link23 onMouseOver="ShowTip(event, 'tt23', 'link23')" onMouseOut="HideTip('tt23')">f_MQTT_Transport_Logging_DEBUG</a></td><td class=SDescription>Logging functions for the DEBUG log level</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_Transport_Logging_WARNING" id=link24 onMouseOver="ShowTip(event, 'tt24', 'link24')" onMouseOut="HideTip('tt24')">f_MQTT_Transport_Logging_WARNING</a></td><td class=SDescription>Logging functions for the WARNING log level</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_Transport_Logging_ERROR" id=link25 onMouseOver="ShowTip(event, 'tt25', 'link25')" onMouseOut="HideTip('tt25')">f_MQTT_Transport_Logging_ERROR</a></td><td class=SDescription>Logging functions for the ERROR log level</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_IPL4asp_handleResult" id=link26 onMouseOver="ShowTip(event, 'tt26', 'link26')" onMouseOut="HideTip('tt26')">f_EPTF_MQTT_IPL4asp_handleResult</a></td><td class=SDescription>Checks the result of an IPL4 transport operation and records an MQTT transport stats warning if unsuccessful</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_init"></a>f_EPTF_MQTT_LocalTransport_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_init() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The main initialization function of the <EPTF_MQTT_LocalTransport_CT> component type</p><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_initLogging"></a>f_EPTF_MQTT_LocalTransport_initLogging</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_initLogging() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializing CLL’s logging feature on the <EPTF_MQTT_LocalTransport_CT> component type</p><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_cleanup"></a>f_EPTF_MQTT_LocalTransport_cleanup</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_cleanup() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The main clean up function for the <EPTF_MQTT_LocalTransport_CT> component type</p><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_IPL4asp_handleEvent"></a>f_EPTF_MQTT_IPL4asp_handleEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_IPL4asp_handleEvent() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Handler function to be registered into the IPL4 transport layer <EPTF_CLL_TransportIPL4_Functions>. It is used to receieve transport events from the underlying IPL4 transport layer. The function currently handles the connection closed event and forwards every event to the load generator layer’s handler function.</p><h4 class=CHeading>Parameters</h4><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_IPL4asp_handleMessage"></a>f_EPTF_MQTT_IPL4asp_handleMessage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_IPL4asp_handleMessage() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Handler function to be regisitered into the IPL4 transport layer <EPTF_CLL_TransportIPL4_Functions>. It is used to receieve MQTT messages from the underlying IPL4 transport layer. The function looks up the entity that owns the particular connection and forwards the message and the entity information to the load generator layer</p><h4 class=CHeading>Parameters</h4><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_send"></a>f_EPTF_MQTT_LocalTransport_send</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>function f_EPTF_MQTT_LocalTransport_send(</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 EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Function to send out a <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link28 onMouseOver="ShowTip(event, 'tt7', 'link28')" onMouseOut="HideTip('tt7')">EPTF_MQTT_PDU</a> message using the local transport. It automatically looks up the corresponding <Socket> or creates it on the fly if it doesn’t exist yet</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_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link29 onMouseOver="ShowTip(event, 'tt7', 'link29')" onMouseOut="HideTip('tt7')">EPTF_MQTT_PDU</a> - message to be sent</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_transportApiRequest"></a>f_EPTF_MQTT_LocalTransport_transportApiRequest</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=3>function f_EPTF_MQTT_LocalTransport_transportApiRequest(</td></tr><tr><td> </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=3>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Function to handle incoming transport API requests</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_Definitions-ttcn.html#EPTF_MQTT_Transport_Request" class=LType id=link30 onMouseOver="ShowTip(event, 'tt28', 'link30')" onMouseOut="HideTip('tt28')">EPTF_MQTT_Transport_Request</a> - transport API request</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_sendApiResponse"></a>f_EPTF_MQTT_LocalTransport_sendApiResponse</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=3>function f_EPTF_MQTT_LocalTransport_sendApiResponse(</td></tr><tr><td> </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=3>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Function to handle incoming transport API requests</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_Definitions-ttcn.html#EPTF_MQTT_Transport_Response" class=LType id=link31 onMouseOver="ShowTip(event, 'tt29', 'link31')" onMouseOut="HideTip('tt29')">EPTF_MQTT_Transport_Response</a> - transport API response</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_startListening"></a>f_EPTF_MQTT_LocalTransport_startListening</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>function f_EPTF_MQTT_LocalTransport_startListening(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_local,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_sessionIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Start listening on a local TCP socket and store its data and state in socketDB</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_local</td><td class=CDLDescription><b>in</b> <Socket> - local socket</td></tr><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session Id stored with the socket data in socketDB</td></tr><tr><td class=CDLEntry>p_idx</td><td class=CDLDescription><b>inout</b> <b>integer</b> - the index of the added element in the database</td></tr></table><h4 class=CHeading>Return Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*boolean*</td><td class=CDLDescription>was the operation succesful?</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_connect"></a>f_EPTF_MQTT_LocalTransport_connect</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>function f_EPTF_MQTT_LocalTransport_connect(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_local,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_remote,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_sessionIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Open a TCP connection and store its data and state in socketDB</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_local</td><td class=CDLDescription><b>in</b> <Socket> - local socket</td></tr><tr><td class=CDLEntry>p_remote</td><td class=CDLDescription><b>in</b> <Socket> - remote socket</td></tr><tr><td class=CDLEntry>pl_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session Id stored with the connection data in socketDB</td></tr><tr><td class=CDLEntry>p_idx</td><td class=CDLDescription><b>inout</b> <b>integer</b> - the index of the added element in the database</td></tr></table><h4 class=CHeading>Return Value</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*boolean*</td><td class=CDLDescription>was the operation succesful?</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_close"></a>f_EPTF_MQTT_LocalTransport_close</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>function f_EPTF_MQTT_LocalTransport_close(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_socketIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Close a TCP connection and remove its entry from the socketDB</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_socketIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the connection in socketDB to be closed</td></tr></table><h4 class=CHeading>Return Value</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*boolean*</td><td class=CDLDescription>was the operation succesful?</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_IPL4_send"></a>f_EPTF_MQTT_LocalTransport_IPL4_send</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>function f_EPTF_MQTT_LocalTransport_IPL4_send(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>pl_connId,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_remName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>pl_remPort,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>ProtoTuple </td><td class="PParameter prettyprint " nowrap width=100%>pl_proto,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>octetstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Send a message and add 1 message and its length to MQTT transport stats variable</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_connId</td><td class=CDLDescription><b>in</b> <b>integer</b> - connection Id</td></tr><tr><td class=CDLEntry>pl_remName</td><td class=CDLDescription><b>in</b> <b>charstring</b> - name of the remote host</td></tr><tr><td class=CDLEntry>pl_remPort</td><td class=CDLDescription><b>in</b> <b>integer</b> - remote port number</td></tr><tr><td class=CDLEntry>pl_proto</td><td class=CDLDescription><b>in</b> <ProtoTuple> - type of protocol of the connection</td></tr><tr><td class=CDLEntry>pl_msg</td><td class=CDLDescription><b>in</b> <b>octetstring</b> - message to be sent</td></tr></table><h4 class=CHeading>Related Type</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_init"></a>f_EPTF_MQTT_LocalTransport_socketDB_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_socketDB_init() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializes the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</p><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_cleanUp"></a>f_EPTF_MQTT_LocalTransport_socketDB_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_socketDB_cleanUp() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cleans up the reserved resources of the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</p><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_add"></a>f_EPTF_MQTT_LocalTransport_socketDB_add</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>function f_EPTF_MQTT_LocalTransport_socketDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>SocketEntry </td><td class="PParameter prettyprint " nowrap width=100%>p_sock</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Adds a new element to the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sock</td><td class=CDLDescription><b>in</b> <SocketEntry> - the element to be added</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*integer*</td><td class=CDLDescription>the index of the added element in the database</td></tr></table><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_lookUp"></a>f_EPTF_MQTT_LocalTransport_socketDB_lookUp</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>function f_EPTF_MQTT_LocalTransport_socketDB_lookUp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_sock</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of an <SocketEntry> element in <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database based on its socket data</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sock</td><td class=CDLDescription><b>in</b> <Socket> - socket data of the element to be found</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*integer*</td><td class=CDLDescription>the index of the element, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_lookUp_connId"></a>f_EPTF_MQTT_LocalTransport_socketDB_lookUp_connId</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>function f_EPTF_MQTT_LocalTransport_socketDB_lookUp_connId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_connId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of an <SocketEntry> element in <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database based on its connection id</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_connId</td><td class=CDLDescription><b>in</b> <b>integer</b> - the connection id</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*integer*</td><td class=CDLDescription>the index of the element, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_get"></a>f_EPTF_MQTT_LocalTransport_socketDB_get</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>function f_EPTF_MQTT_LocalTransport_socketDB_get(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>SocketEntry </td><td class="PParameter prettyprint " nowrap width=100%>p_sock</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Retrieves an element from the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_idx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the element to be retrieved</td></tr><tr><td class=CDLEntry>p_sock</td><td class=CDLDescription><b>inout</b> <SocketEntry> - the retrieved element</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolean</td><td class=CDLDescription>was the operation successful?</td></tr></table><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LocalTransport_socketDB_remove"></a>f_EPTF_MQTT_LocalTransport_socketDB_remove</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>function f_EPTF_MQTT_LocalTransport_socketDB_remove(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removes an element from the <b>v_MQTT_LocalTransport_localSocketDB</b> <SocketDB> database and frees up its reserved resources</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_idx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the element to be removed</td></tr></table><h4 class=CHeading>Related Type</h4><p><SocketDB> <EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_Socket2String"></a>f_EPTF_MQTT_Socket2String</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 "nowrap>function f_EPTF_MQTT_Socket2String(</td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap>p_sock</td><td class="PAfterParameters prettyprint "nowrap>) return charstring</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Converts socket data from <Socket> type to the format “<hostname>:<port number>”</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sock</td><td class=CDLDescription><b>in</b> <Socket> - Socket data to be converted</td></tr></table><h4 class=CHeading>Return</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>charstring</td><td class=CDLDescription>the converted socket data</td></tr></table></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_Transport_Logging_VERBOSE"></a>f_MQTT_Transport_Logging_VERBOSE</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>function f_MQTT_Transport_Logging_VERBOSE(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Logging functions for the VERBOSE log level</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> <b>charstring</b> - string to be logged</td></tr></table><h4 class=CHeading>Related Types</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_Transport_Logging_DEBUG"></a>f_MQTT_Transport_Logging_DEBUG</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>function f_MQTT_Transport_Logging_DEBUG(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Logging functions for the DEBUG log level</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> <b>charstring</b> - string to be logged</td></tr></table><h4 class=CHeading>Related Types</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_Transport_Logging_WARNING"></a>f_MQTT_Transport_Logging_WARNING</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>function f_MQTT_Transport_Logging_WARNING(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Logging functions for the WARNING log level</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> <b>charstring</b> - string to be logged</td></tr></table><h4 class=CHeading>Related Types</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_Transport_Logging_ERROR"></a>f_MQTT_Transport_Logging_ERROR</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>function f_MQTT_Transport_Logging_ERROR(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Logging functions for the ERROR log level</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> <b>charstring</b> - string to be logged</td></tr></table><h4 class=CHeading>Related Types</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_IPL4asp_handleResult"></a>f_EPTF_MQTT_IPL4asp_handleResult</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>function f_EPTF_MQTT_IPL4asp_handleResult(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>Result </td><td class="PParameter prettyprint " nowrap width=100%>p_res</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Checks the result of an IPL4 transport operation and records an MQTT transport stats warning if unsuccessful</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_res</td><td class=CDLDescription><b>inout</b> <b>Result</b> - result of an IPL4 transport operation</td></tr></table><h4 class=CHeading>Return Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolen</td><td class=CDLDescription><b>true</b>: no error or “Temporary unavailable”, <b>false</b>: error different from “Temporary unavailable”</td></tr></table><h4 class=CHeading>Related Types</h4><p><EPTF_MQTT_LocalTransport_CT></p></div></div></div> |
| |
| </div><!--Content--> |
| |
| |
| |
| <!--START_ND_TOOLTIPS--> |
| <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_init() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>The main initialization function of the EPTF_MQTT_LocalTransport_CT component type</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_initLogging() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>Initializing CLL’s logging feature on the EPTF_MQTT_LocalTransport_CT component type</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_cleanup() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>The main clean up function for the EPTF_MQTT_LocalTransport_CT component type</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_IPL4asp_handleEvent() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>Handler function to be registered into the IPL4 transport layer EPTF_CLL_TransportIPL4_Functions. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_IPL4asp_handleMessage() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>Handler function to be regisitered into the IPL4 transport layer EPTF_CLL_TransportIPL4_Functions. </div></div><div class=CToolTip id="tt6"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_send(</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 EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Function to send out a EPTF_MQTT_PDU message using the local transport. </div></div><div class=CToolTip id="tt7"><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="tt8"><div class=CFunction><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=3>function f_EPTF_MQTT_LocalTransport_transportApiRequest(</td></tr><tr><td> </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=3>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Function to handle incoming transport API requests</div></div><div class=CToolTip id="tt9"><div class=CFunction><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=3>function f_EPTF_MQTT_LocalTransport_sendApiResponse(</td></tr><tr><td> </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=3>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Function to handle incoming transport API requests</div></div><div class=CToolTip id="tt10"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_startListening(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_local,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_sessionIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote>Start listening on a local TCP socket and store its data and state in socketDB</div></div><div class=CToolTip id="tt11"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_connect(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_local,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_remote,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_sessionIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote>Open a TCP connection and store its data and state in socketDB</div></div><div class=CToolTip id="tt12"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_close(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_socketIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote>Close a TCP connection and remove its entry from the socketDB</div></div><div class=CToolTip id="tt13"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_IPL4_send(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>pl_connId,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_remName,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>pl_remPort,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>ProtoTuple </td><td class="PParameter prettyprint " nowrap width=100%>pl_proto,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>octetstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Send a message and add 1 message and its length to MQTT transport stats variable</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_socketDB_init() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>Initializes the <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LocalTransport_socketDB_cleanUp() runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></blockquote>Cleans up the reserved resources of the <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database</div></div><div class=CToolTip id="tt16"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_socketDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>SocketEntry </td><td class="PParameter prettyprint " nowrap width=100%>p_sock</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return integer</td></tr></table></td></tr></table></blockquote>Adds a new element to the <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database</div></div><div class=CToolTip id="tt17"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_socketDB_lookUp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_sock</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of an SocketEntry element in <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database based on its socket data</div></div><div class=CToolTip id="tt18"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_socketDB_lookUp_connId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_connId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of an SocketEntry element in <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database based on its connection id</div></div><div class=CToolTip id="tt19"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_socketDB_get(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>SocketEntry </td><td class="PParameter prettyprint " nowrap width=100%>p_sock</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote>Retrieves an element from the <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database</div></div><div class=CToolTip id="tt20"><div class=CFunction><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>function f_EPTF_MQTT_LocalTransport_socketDB_remove(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_idx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Removes an element from the <b>v_MQTT_LocalTransport_localSocketDB</b> SocketDB database and frees up its reserved resources</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_EPTF_MQTT_Socket2String(</td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap>p_sock</td><td class="PAfterParameters prettyprint "nowrap>) return charstring</td></tr></table></td></tr></table></blockquote>Converts socket data from Socket type to the format “hostname:<port number>”</div></div><div class=CToolTip id="tt22"><div class=CFunction><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>function f_MQTT_Transport_Logging_VERBOSE(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the VERBOSE log level</div></div><div class=CToolTip id="tt23"><div class=CFunction><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>function f_MQTT_Transport_Logging_DEBUG(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the DEBUG log level</div></div><div class=CToolTip id="tt24"><div class=CFunction><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>function f_MQTT_Transport_Logging_WARNING(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the WARNING log level</div></div><div class=CToolTip id="tt25"><div class=CFunction><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>function f_MQTT_Transport_Logging_ERROR(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in @lazy </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_message</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the ERROR log level</div></div><div class=CToolTip id="tt26"><div class=CFunction><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>function f_EPTF_MQTT_IPL4asp_handleResult(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>Result </td><td class="PParameter prettyprint " nowrap width=100%>p_res</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LocalTransport_CT return boolean</td></tr></table></td></tr></table></blockquote>Checks the result of an IPL4 transport operation and records an MQTT transport stats warning if unsuccessful</div></div><div class=CToolTip id="tt27"><div class=CFile>This module contains the definitions for the MQTT local transport component</div></div><div class=CToolTip id="tt28"><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="tt29"><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><!--END_ND_TOOLTIPS--> |
| |
| <script language=JavaScript><!-- |
| if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |
