| <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>EPTF_MQTT_LGen_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_LGen_Functions"></a>EPTF_MQTT_LGen_Functions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the functions of the MQTT load generator component</p><h4 class=CHeading>See also</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_Definitions" class=LFile id=link193 onMouseOver="ShowTip(event, 'tt128', 'link193')" onMouseOut="HideTip('tt128')">EPTF_MQTT_LGen_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_LGen_Functions" >EPTF_MQTT_LGen_Functions</a></td><td class=SDescription>This module contains the functions of the MQTT load generator component</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LGen_init" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">f_EPTF_MQTT_LGen_init</a></td><td class=SDescription>The main initialization function for the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component type</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LGen_initLogging" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">f_EPTF_MQTT_LGen_initLogging</a></td><td class=SDescription>Initializing CLL’s logging feature on the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component type</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_cleanUp" id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">f_MQTT_cleanUp</a></td><td class=SDescription>The main clean up function for the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link6 onMouseOver="ShowTip(event, 'tt2', 'link6')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component type</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_eCtxBind" id=link7 onMouseOver="ShowTip(event, 'tt5', 'link7')" onMouseOut="HideTip('tt5')">f_MQTT_eCtxBind</a></td><td class=SDescription>This function is called by the CLL for each entity instance created on a particular instace of <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link8 onMouseOver="ShowTip(event, 'tt2', 'link8')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_eCtxUnbind" id=link9 onMouseOver="ShowTip(event, 'tt6', 'link9')" onMouseOut="HideTip('tt6')">f_MQTT_eCtxUnbind</a></td><td class=SDescription>The reverse operation of <a href="#f_MQTT_eCtxBind" class=LFunction id=link10 onMouseOver="ShowTip(event, 'tt5', 'link10')" onMouseOut="HideTip('tt5')">f_MQTT_eCtxBind</a>. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_eCtxReset" id=link11 onMouseOver="ShowTip(event, 'tt7', 'link11')" onMouseOut="HideTip('tt7')">f_MQTT_eCtxReset</a></td><td class=SDescription>The resources reserved during <a href="#f_MQTT_eCtxBind" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt5', 'link12')" onMouseOut="HideTip('tt5')">f_MQTT_eCtxBind</a> are reinitalized (reset). </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_declareEvents" id=link13 onMouseOver="ShowTip(event, 'tt8', 'link13')" onMouseOut="HideTip('tt8')">f_EPTF_MQTT_declareEvents</a></td><td class=SDescription>Declares the FSM events to the CLL framework implemented by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link14 onMouseOver="ShowTip(event, 'tt2', 'link14')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_declareSteps" id=link15 onMouseOver="ShowTip(event, 'tt9', 'link15')" onMouseOut="HideTip('tt9')">f_EPTF_MQTT_declareSteps</a></td><td class=SDescription>Declares the FSM steps to the CLL framework implemented by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link16 onMouseOver="ShowTip(event, 'tt2', 'link16')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LGen_receiveMessage" id=link17 onMouseOver="ShowTip(event, 'tt10', 'link17')" onMouseOut="HideTip('tt10')">f_EPTF_MQTT_LGen_receiveMessage</a></td><td class=SDescription>The transport layer implementation <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link18 onMouseOver="ShowTip(event, 'tt11', 'link18')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a> can report received <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link19 onMouseOver="ShowTip(event, 'tt12', 'link19')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> message to the load generator layer <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link20 onMouseOver="ShowTip(event, 'tt13', 'link20')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a> extended by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link21 onMouseOver="ShowTip(event, 'tt2', 'link21')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> using this function.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LGen_receiveEvent" id=link22 onMouseOver="ShowTip(event, 'tt14', 'link22')" onMouseOut="HideTip('tt14')">f_EPTF_MQTT_LGen_receiveEvent</a></td><td class=SDescription>The transport layer implementation <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link23 onMouseOver="ShowTip(event, 'tt11', 'link23')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a> can report received <ASP_Event> events to the load generator layer <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link24 onMouseOver="ShowTip(event, 'tt13', 'link24')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a> extended by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link25 onMouseOver="ShowTip(event, 'tt2', 'link25')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> using this function.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_LGen_transportApiResponse" id=link26 onMouseOver="ShowTip(event, 'tt15', 'link26')" onMouseOut="HideTip('tt15')">f_EPTF_MQTT_LGen_transportApiResponse</a></td><td class=SDescription>The transport layer implementation <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link27 onMouseOver="ShowTip(event, 'tt11', 'link27')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a> can report received <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Response" class=LType id=link28 onMouseOver="ShowTip(event, 'tt16', 'link28')" onMouseOut="HideTip('tt16')">EPTF_MQTT_Transport_Response</a> responses to the load generator layer <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link29 onMouseOver="ShowTip(event, 'tt13', 'link29')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a> extended by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link30 onMouseOver="ShowTip(event, 'tt2', 'link30')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> using this function.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_LGen_send" id=link31 onMouseOver="ShowTip(event, 'tt17', 'link31')" onMouseOut="HideTip('tt17')">f_EPTF_MQTT_LGen_send</a></td><td class=SDescription>This function is used to send out a message of a <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link32 onMouseOver="ShowTip(event, 'tt12', 'link32')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> using the registered function <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_sendMessage" class=LType id=link33 onMouseOver="ShowTip(event, 'tt18', 'link33')" onMouseOut="HideTip('tt18')">fcb_EPTF_MQTT_Transport_sendMessage</a> of the underlying transport layer instance.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_init" id=link34 onMouseOver="ShowTip(event, 'tt19', 'link34')" onMouseOut="HideTip('tt19')">f_MQTT_step_init</a></td><td class=SDescription>Test Step to dynamically allocate and initialize the MQTT FSM context for the caller FSM. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_cleanUp" id=link35 onMouseOver="ShowTip(event, 'tt20', 'link35')" onMouseOut="HideTip('tt20')">f_MQTT_step_cleanUp</a></td><td class=SDescription>Test Step to free up the MQTT FSM context for the caller FSM. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_setLocalAddress_byVars" id=link36 onMouseOver="ShowTip(event, 'tt21', 'link36')" onMouseOut="HideTip('tt21')">f_MQTT_step_setLocalAddress_byVars</a></td><td class=SDescription>Test step to set the local address in the entity context.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_setRemoteAddress_byVars" id=link37 onMouseOver="ShowTip(event, 'tt22', 'link37')" onMouseOut="HideTip('tt22')">f_MQTT_step_setRemoteAddress_byVars</a></td><td class=SDescription>Test step to set the remote address in the FSM context.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_startListening" id=link38 onMouseOver="ShowTip(event, 'tt23', 'link38')" onMouseOut="HideTip('tt23')">f_MQTT_step_startListening</a></td><td class=SDescription>The test step expects that a transport endpoint is set in the addressDB as a local address. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_transportConnect" id=link39 onMouseOver="ShowTip(event, 'tt24', 'link39')" onMouseOut="HideTip('tt24')">f_MQTT_step_transportConnect</a></td><td class=SDescription>The test step expects that local and remote socket adresses are set in the addressDB. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_transportClose" id=link40 onMouseOver="ShowTip(event, 'tt25', 'link40')" onMouseOut="HideTip('tt25')">f_MQTT_step_transportClose</a></td><td class=SDescription>The test step expects that a transport endpoint is set in the addressDB as a local address. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_loadTemplate_byIntIdx" id=link41 onMouseOver="ShowTip(event, 'tt26', 'link41')" onMouseOut="HideTip('tt26')">f_MQTT_step_loadTemplate_byIntIdx</a></td><td class=SDescription>Test step to load a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link42 onMouseOver="ShowTip(event, 'tt27', 'link42')" onMouseOut="HideTip('tt27')">MQTT_Template</a> from <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#tsp_EPTF_MQTT_LGen_templates" class=LModuleParameter id=link43 onMouseOver="ShowTip(event, 'tt28', 'link43')" onMouseOut="HideTip('tt28')">tsp_EPTF_MQTT_LGen_templates</a> into <b>v_MQTT_msgToSend</b> (which can be sent using the send test step) by its integer index in test step args.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_loadTemplate_byStringId" id=link44 onMouseOver="ShowTip(event, 'tt29', 'link44')" onMouseOut="HideTip('tt29')">f_MQTT_step_loadTemplate_byStringId</a></td><td class=SDescription>Test step to load a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link45 onMouseOver="ShowTip(event, 'tt27', 'link45')" onMouseOut="HideTip('tt27')">MQTT_Template</a> from <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#tsp_EPTF_MQTT_LGen_templates" class=LModuleParameter id=link46 onMouseOver="ShowTip(event, 'tt28', 'link46')" onMouseOut="HideTip('tt28')">tsp_EPTF_MQTT_LGen_templates</a> into <b>v_MQTT_msgToSend</b> (which can be sent using the send test step) by its string Id.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_setTopic_stringParam" id=link47 onMouseOver="ShowTip(event, 'tt30', 'link47')" onMouseOut="HideTip('tt30')">f_MQTT_step_setTopic_stringParam</a></td><td class=SDescription>Test step to set the string value referred by the test step argument as the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_setTopic_add_stringParam" id=link48 onMouseOver="ShowTip(event, 'tt31', 'link48')" onMouseOut="HideTip('tt31')">f_MQTT_step_setTopic_add_stringParam</a></td><td class=SDescription>Test step to add the string value referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_setTopic_add_varParams" id=link49 onMouseOver="ShowTip(event, 'tt32', 'link49')" onMouseOut="HideTip('tt32')">f_MQTT_step_setTopic_add_varParams</a></td><td class=SDescription>Test step to add the string value of variables referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_setTopic_add_clientId" id=link50 onMouseOver="ShowTip(event, 'tt33', 'link50')" onMouseOut="HideTip('tt33')">f_MQTT_step_setTopic_add_clientId</a></td><td class=SDescription>Test step to add client ID in the current session to the topic in the first subscription in SUBSCRIBE and to PUBLISH message.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_setQos_intParam" id=link51 onMouseOver="ShowTip(event, 'tt34', 'link51')" onMouseOut="HideTip('tt34')">f_MQTT_step_setQos_intParam</a></td><td class=SDescription>Test step to set the QoS level in SUBSCRIBE and PUBLISH messages using test step arguments</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_setPublishMessage_stringParam" id=link52 onMouseOver="ShowTip(event, 'tt35', 'link52')" onMouseOut="HideTip('tt35')">f_MQTT_step_setPublishMessage_stringParam</a></td><td class=SDescription>Test step to set the content of the payload in PUBLISH message.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_setPublishMessage_add_stringParam" id=link53 onMouseOver="ShowTip(event, 'tt36', 'link53')" onMouseOut="HideTip('tt36')">f_MQTT_step_setPublishMessage_add_stringParam</a></td><td class=SDescription>Test step to concatenate a string to the content of the PUBLISH message</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_setPublishMessage_add_varParams" id=link54 onMouseOver="ShowTip(event, 'tt37', 'link54')" onMouseOut="HideTip('tt37')">f_MQTT_step_setPublishMessage_add_varParams</a></td><td class=SDescription>Test step to add the content of a set of variables to the payload of a PUBLISH message.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_setPublishMessage_add_clientId" id=link55 onMouseOver="ShowTip(event, 'tt38', 'link55')" onMouseOut="HideTip('tt38')">f_MQTT_step_setPublishMessage_add_clientId</a></td><td class=SDescription>Test step to add client ID of the current session to the payload of a PUBLISH message.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_reportPingResponse" id=link56 onMouseOver="ShowTip(event, 'tt39', 'link56')" onMouseOut="HideTip('tt39')">f_MQTT_step_reportPingResponse</a></td><td class=SDescription>Test step to set the report ping response to enable/disable using using step arguments.</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_MQTT_step_reportPublishResponse" id=link57 onMouseOver="ShowTip(event, 'tt40', 'link57')" onMouseOut="HideTip('tt40')">f_MQTT_step_reportPublishResponse</a></td><td class=SDescription>Test step to set the report publish response to enable/disable using step arguments</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_MQTT_step_send" id=link58 onMouseOver="ShowTip(event, 'tt41', 'link58')" onMouseOut="HideTip('tt41')">f_MQTT_step_send</a></td><td class=SDescription>Test step to send out an MQTT message from <b>v_MQTT_msgToSend</b>. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_addressDB_init" id=link59 onMouseOver="ShowTip(event, 'tt42', 'link59')" onMouseOut="HideTip('tt42')">f_EPTF_MQTT_addressDB_init</a></td><td class=SDescription>Function to initialize the addressDB</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_addressDB_cleanUp" id=link60 onMouseOver="ShowTip(event, 'tt43', 'link60')" onMouseOut="HideTip('tt43')">f_EPTF_MQTT_addressDB_cleanUp</a></td><td class=SDescription>Function to clean up the address database and release its resources</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_addressDB_add" id=link61 onMouseOver="ShowTip(event, 'tt44', 'link61')" onMouseOut="HideTip('tt44')">f_EPTF_MQTT_addressDB_add</a></td><td class=SDescription>Add a socket address to the addressDB and return its index if no such entry yet, or return its index if already exists</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_addressDB_get" id=link62 onMouseOver="ShowTip(event, 'tt45', 'link62')" onMouseOut="HideTip('tt45')">f_EPTF_MQTT_addressDB_get</a></td><td class=SDescription>Get a socket address from the addressDB by its index</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_addressDB_lookUp" id=link63 onMouseOver="ShowTip(event, 'tt46', 'link63')" onMouseOut="HideTip('tt46')">f_EPTF_MQTT_addressDB_lookUp</a></td><td class=SDescription>Get the index of a socket entry in addressDB</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_addressDB_Socket2String" id=link64 onMouseOver="ShowTip(event, 'tt47', 'link64')" onMouseOut="HideTip('tt47')">f_EPTF_MQTT_addressDB_Socket2String</a></td><td class=SDescription>Converts a socket address in <Socket> type format to the string format “<IP address>:<port number>” to be used as hash key</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_templateDB_init" id=link65 onMouseOver="ShowTip(event, 'tt48', 'link65')" onMouseOut="HideTip('tt48')">f_EPTF_MQTT_templateDB_init</a></td><td class=SDescription>Initializes the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link66 onMouseOver="ShowTip(event, 'tt49', 'link66')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database by adding the templates given in <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#tsp_EPTF_MQTT_LGen_templates" class=LModuleParameter id=link67 onMouseOver="ShowTip(event, 'tt28', 'link67')" onMouseOut="HideTip('tt28')">tsp_EPTF_MQTT_LGen_templates</a></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_templateDB_add" id=link68 onMouseOver="ShowTip(event, 'tt50', 'link68')" onMouseOut="HideTip('tt50')">f_EPTF_MQTT_templateDB_add</a></td><td class=SDescription>Adds a new element to the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link69 onMouseOver="ShowTip(event, 'tt49', 'link69')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_templateDB_lookUp" id=link70 onMouseOver="ShowTip(event, 'tt51', 'link70')" onMouseOut="HideTip('tt51')">f_EPTF_MQTT_templateDB_lookUp</a></td><td class=SDescription>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link71 onMouseOver="ShowTip(event, 'tt27', 'link71')" onMouseOut="HideTip('tt27')">MQTT_Template</a> element in <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link72 onMouseOver="ShowTip(event, 'tt49', 'link72')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_templateDB_get" id=link73 onMouseOver="ShowTip(event, 'tt52', 'link73')" onMouseOut="HideTip('tt52')">f_EPTF_MQTT_templateDB_get</a></td><td class=SDescription>Retrieves an element from the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link74 onMouseOver="ShowTip(event, 'tt49', 'link74')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_templateDB_cleanUp" id=link75 onMouseOver="ShowTip(event, 'tt53', 'link75')" onMouseOut="HideTip('tt53')">f_EPTF_MQTT_templateDB_cleanUp</a></td><td class=SDescription>Cleans up the reserved resources of the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link76 onMouseOver="ShowTip(event, 'tt49', 'link76')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_init" id=link77 onMouseOver="ShowTip(event, 'tt54', 'link77')" onMouseOut="HideTip('tt54')">f_EPTF_MQTT_sessionDB_init</a></td><td class=SDescription>Initializes the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link78 onMouseOver="ShowTip(event, 'tt55', 'link78')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database and adds its hash to <b>v_MQTT_sessionDB.hashRef</b></td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_cleanUp" id=link79 onMouseOver="ShowTip(event, 'tt56', 'link79')" onMouseOut="HideTip('tt56')">f_EPTF_MQTT_sessionDB_cleanUp</a></td><td class=SDescription>Cleans up the reserved resources of the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link80 onMouseOver="ShowTip(event, 'tt55', 'link80')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_add" id=link81 onMouseOver="ShowTip(event, 'tt57', 'link81')" onMouseOut="HideTip('tt57')">f_EPTF_MQTT_sessionDB_add</a></td><td class=SDescription>Adds a new element to the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link82 onMouseOver="ShowTip(event, 'tt55', 'link82')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_setKey" id=link83 onMouseOver="ShowTip(event, 'tt58', 'link83')" onMouseOut="HideTip('tt58')">f_EPTF_MQTT_sessionDB_setKey</a></td><td class=SDescription>Sets the hash of the local socket address of a session by the session index</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_lookUp" id=link84 onMouseOver="ShowTip(event, 'tt59', 'link84')" onMouseOut="HideTip('tt59')">f_EPTF_MQTT_sessionDB_lookUp</a></td><td class=SDescription>Gets the index of a session in <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link85 onMouseOver="ShowTip(event, 'tt55', 'link85')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database by its socket address</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_get" id=link86 onMouseOver="ShowTip(event, 'tt60', 'link86')" onMouseOut="HideTip('tt60')">f_EPTF_MQTT_sessionDB_get</a></td><td class=SDescription>Retrieves a session’s data from the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link87 onMouseOver="ShowTip(event, 'tt55', 'link87')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_check" id=link88 onMouseOver="ShowTip(event, 'tt61', 'link88')" onMouseOut="HideTip('tt61')">f_EPTF_MQTT_sessionDB_check</a></td><td class=SDescription>Checks if a session element exists in the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link89 onMouseOver="ShowTip(event, 'tt55', 'link89')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_remove" id=link90 onMouseOver="ShowTip(event, 'tt62', 'link90')" onMouseOut="HideTip('tt62')">f_EPTF_MQTT_sessionDB_remove</a></td><td class=SDescription>Removes an element from the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link91 onMouseOver="ShowTip(event, 'tt55', 'link91')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database and releases its resources</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_sessionDB_addrHash" id=link92 onMouseOver="ShowTip(event, 'tt63', 'link92')" onMouseOut="HideTip('tt63')">f_EPTF_MQTT_sessionDB_addrHash</a></td><td class=SDescription>Converts a socket address in <Socket> type format to the string format “<IP address>:<port number>” to be used as a hash key</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_init" id=link93 onMouseOver="ShowTip(event, 'tt64', 'link93')" onMouseOut="HideTip('tt64')">f_EPTF_MQTT_publishDB_init</a></td><td class=SDescription>Initializes the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link94 onMouseOver="ShowTip(event, 'tt65', 'link94')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database and creates its hashmap</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_cleanUp" id=link95 onMouseOver="ShowTip(event, 'tt66', 'link95')" onMouseOut="HideTip('tt66')">f_EPTF_MQTT_publishDB_cleanUp</a></td><td class=SDescription>Cleans up the reserved resources of the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link96 onMouseOver="ShowTip(event, 'tt65', 'link96')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_add" id=link97 onMouseOver="ShowTip(event, 'tt67', 'link97')" onMouseOut="HideTip('tt67')">f_EPTF_MQTT_publishDB_add</a></td><td class=SDescription>Adds a new element to the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link98 onMouseOver="ShowTip(event, 'tt65', 'link98')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_lookUp" id=link99 onMouseOver="ShowTip(event, 'tt68', 'link99')" onMouseOut="HideTip('tt68')">f_EPTF_MQTT_publishDB_lookUp</a></td><td class=SDescription>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link100 onMouseOver="ShowTip(event, 'tt69', 'link100')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> element in <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link101 onMouseOver="ShowTip(event, 'tt65', 'link101')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database by its session and packet id-s</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_get" id=link102 onMouseOver="ShowTip(event, 'tt70', 'link102')" onMouseOut="HideTip('tt70')">f_EPTF_MQTT_publishDB_get</a></td><td class=SDescription>Retrieves an element from the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link103 onMouseOver="ShowTip(event, 'tt65', 'link103')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_check" id=link104 onMouseOver="ShowTip(event, 'tt71', 'link104')" onMouseOut="HideTip('tt71')">f_EPTF_MQTT_publishDB_check</a></td><td class=SDescription>Checks if an element exists in the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link105 onMouseOver="ShowTip(event, 'tt65', 'link105')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_remove" id=link106 onMouseOver="ShowTip(event, 'tt72', 'link106')" onMouseOut="HideTip('tt72')">f_EPTF_MQTT_publishDB_remove</a></td><td class=SDescription>Removes an element from the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link107 onMouseOver="ShowTip(event, 'tt65', 'link107')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publishDB_packetIdHash" id=link108 onMouseOver="ShowTip(event, 'tt73', 'link108')" onMouseOut="HideTip('tt73')">f_EPTF_MQTT_publishDB_packetIdHash</a></td><td class=SDescription>Converts a pair of session ID & packet ID to the string format “session_<sessionId>:id_<packetId>” to be used as a hash key</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_init" id=link109 onMouseOver="ShowTip(event, 'tt74', 'link109')" onMouseOut="HideTip('tt74')">f_EPTF_MQTT_subscriptionDB_init</a></td><td class=SDescription>Initializes the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link110 onMouseOver="ShowTip(event, 'tt75', 'link110')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_cleanUp" id=link111 onMouseOver="ShowTip(event, 'tt76', 'link111')" onMouseOut="HideTip('tt76')">f_EPTF_MQTT_subscriptionDB_cleanUp</a></td><td class=SDescription>Cleans up the reserved resources of the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link112 onMouseOver="ShowTip(event, 'tt75', 'link112')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_add" id=link113 onMouseOver="ShowTip(event, 'tt77', 'link113')" onMouseOut="HideTip('tt77')">f_EPTF_MQTT_subscriptionDB_add</a></td><td class=SDescription>Adds a new element to the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link114 onMouseOver="ShowTip(event, 'tt75', 'link114')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_setKey_packetId" id=link115 onMouseOver="ShowTip(event, 'tt78', 'link115')" onMouseOut="HideTip('tt78')">f_EPTF_MQTT_subscriptionDB_setKey_packetId</a></td><td class=SDescription>Insert an integer element to the subscription hashmap, key is composed from session ID and packet ID</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_removeKey_packetId" id=link116 onMouseOver="ShowTip(event, 'tt79', 'link116')" onMouseOut="HideTip('tt79')">f_EPTF_MQTT_subscriptionDB_removeKey_packetId</a></td><td class=SDescription>Removes the element from the subscription hashmap identified by its session ID and packet ID</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_lookUp_packetId" id=link117 onMouseOver="ShowTip(event, 'tt80', 'link117')" onMouseOut="HideTip('tt80')">f_EPTF_MQTT_subscriptionDB_lookUp_packetId</a></td><td class=SDescription>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link118 onMouseOver="ShowTip(event, 'tt81', 'link118')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> element in <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link119 onMouseOver="ShowTip(event, 'tt75', 'link119')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database by a session ID and packet ID</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_lookUp_topicName" id=link120 onMouseOver="ShowTip(event, 'tt82', 'link120')" onMouseOut="HideTip('tt82')">f_EPTF_MQTT_subscriptionDB_lookUp_topicName</a></td><td class=SDescription>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link121 onMouseOver="ShowTip(event, 'tt81', 'link121')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> element in <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link122 onMouseOver="ShowTip(event, 'tt75', 'link122')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database by a session ID and packet ID</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_get" id=link123 onMouseOver="ShowTip(event, 'tt83', 'link123')" onMouseOut="HideTip('tt83')">f_EPTF_MQTT_subscriptionDB_get</a></td><td class=SDescription>Retrieves an element from the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link124 onMouseOver="ShowTip(event, 'tt75', 'link124')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_check" id=link125 onMouseOver="ShowTip(event, 'tt84', 'link125')" onMouseOut="HideTip('tt84')">f_EPTF_MQTT_subscriptionDB_check</a></td><td class=SDescription>Checks if an element at an index exists the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link126 onMouseOver="ShowTip(event, 'tt75', 'link126')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_remove" id=link127 onMouseOver="ShowTip(event, 'tt85', 'link127')" onMouseOut="HideTip('tt85')">f_EPTF_MQTT_subscriptionDB_remove</a></td><td class=SDescription>Removes an element from the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link128 onMouseOver="ShowTip(event, 'tt75', 'link128')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_packetIdHash" id=link129 onMouseOver="ShowTip(event, 'tt86', 'link129')" onMouseOut="HideTip('tt86')">f_EPTF_MQTT_subscriptionDB_packetIdHash</a></td><td class=SDescription>Converts a pair of session ID & packet ID to the string format “session_<sessionId>:id_<packetId>” to be used as hash key</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscriptionDB_topicHash" id=link130 onMouseOver="ShowTip(event, 'tt87', 'link130')" onMouseOut="HideTip('tt87')">f_EPTF_MQTT_subscriptionDB_topicHash</a></td><td class=SDescription>Converts a pair of session ID & topic to the string format “session_<sessionId>:topic_<topic>” to be used as hash key</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_stack_fromApp" id=link131 onMouseOver="ShowTip(event, 'tt88', 'link131')" onMouseOut="HideTip('tt88')">f_EPTF_MQTT_stack_fromApp</a></td><td class=SDescription>This is the main entry point for the MQTT stack realization of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link132 onMouseOver="ShowTip(event, 'tt2', 'link132')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component that handles messages received from the application layer (e.g. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_stack_fromEnv" id=link133 onMouseOver="ShowTip(event, 'tt89', 'link133')" onMouseOut="HideTip('tt89')">f_EPTF_MQTT_stack_fromEnv</a></td><td class=SDescription>This is the main entry point for the MQTT stack realization of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link134 onMouseOver="ShowTip(event, 'tt2', 'link134')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component that handles messages received from the environment layer (e.g. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_fromApp" id=link135 onMouseOver="ShowTip(event, 'tt90', 'link135')" onMouseOut="HideTip('tt90')">f_EPTF_MQTT_session_fromApp</a></td><td class=SDescription>This is the entry point for an MQTT session fsm handling events coming from the application layer (e.g. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_session_fromEnv" id=link136 onMouseOver="ShowTip(event, 'tt91', 'link136')" onMouseOut="HideTip('tt91')">f_EPTF_MQTT_session_fromEnv</a></td><td class=SDescription>This is the entry point for an MQTT session fsm from the environment layer (e.g. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_keepalive" id=link137 onMouseOver="ShowTip(event, 'tt92', 'link137')" onMouseOut="HideTip('tt92')">f_EPTF_MQTT_session_keepalive</a></td><td class=SDescription>Handles the T_keepalive timer event in the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link138 onMouseOver="ShowTip(event, 'tt93', 'link138')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_session_startT_keepalive" id=link139 onMouseOver="ShowTip(event, 'tt94', 'link139')" onMouseOut="HideTip('tt94')">f_EPTF_MQTT_session_startT_keepalive</a></td><td class=SDescription>Starts the T_keepalive timer for an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link140 onMouseOver="ShowTip(event, 'tt93', 'link140')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_cancelT_keepalive" id=link141 onMouseOver="ShowTip(event, 'tt95', 'link141')" onMouseOut="HideTip('tt95')">f_EPTF_MQTT_session_cancelT_keepalive</a></td><td class=SDescription>Cancels the T_keepalive timer of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link142 onMouseOver="ShowTip(event, 'tt93', 'link142')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_session_getNextPacketId" id=link143 onMouseOver="ShowTip(event, 'tt96', 'link143')" onMouseOut="HideTip('tt96')">f_EPTF_MQTT_session_getNextPacketId</a></td><td class=SDescription>Sets the value of the packet id field in the next message to be sent in a session</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_setState" id=link144 onMouseOver="ShowTip(event, 'tt97', 'link144')" onMouseOut="HideTip('tt97')">f_EPTF_MQTT_session_setState</a></td><td class=SDescription>Sets a new state for an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link145 onMouseOver="ShowTip(event, 'tt93', 'link145')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_session_send" id=link146 onMouseOver="ShowTip(event, 'tt98', 'link146')" onMouseOut="HideTip('tt98')">f_EPTF_MQTT_session_send</a></td><td class=SDescription>Sends a message to the transort layer with type <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link147 onMouseOver="ShowTip(event, 'tt12', 'link147')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> and the provided session index</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_registerSubscription" id=link148 onMouseOver="ShowTip(event, 'tt99', 'link148')" onMouseOut="HideTip('tt99')">f_EPTF_MQTT_session_registerSubscription</a></td><td class=SDescription>Adds a subscription index to an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link149 onMouseOver="ShowTip(event, 'tt93', 'link149')" onMouseOut="HideTip('tt93')">MQTT_Session</a></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_session_deregisterSubscription" id=link150 onMouseOver="ShowTip(event, 'tt100', 'link150')" onMouseOut="HideTip('tt100')">f_EPTF_MQTT_session_deregisterSubscription</a></td><td class=SDescription>Removes a subscription index from <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link151 onMouseOver="ShowTip(event, 'tt93', 'link151')" onMouseOut="HideTip('tt93')">MQTT_Session</a></td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_registerPublish" id=link152 onMouseOver="ShowTip(event, 'tt101', 'link152')" onMouseOut="HideTip('tt101')">f_EPTF_MQTT_session_registerPublish</a></td><td class=SDescription>Adds a publish index to an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link153 onMouseOver="ShowTip(event, 'tt93', 'link153')" onMouseOut="HideTip('tt93')">MQTT_Session</a></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_session_deregisterPublish" id=link154 onMouseOver="ShowTip(event, 'tt102', 'link154')" onMouseOut="HideTip('tt102')">f_EPTF_MQTT_session_deregisterPublish</a></td><td class=SDescription>Removes a publish index from an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link155 onMouseOver="ShowTip(event, 'tt93', 'link155')" onMouseOut="HideTip('tt93')">MQTT_Session</a></td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_session_remove" id=link156 onMouseOver="ShowTip(event, 'tt103', 'link156')" onMouseOut="HideTip('tt103')">f_EPTF_MQTT_session_remove</a></td><td class=SDescription>Releases all resources related to an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link157 onMouseOver="ShowTip(event, 'tt93', 'link157')" onMouseOut="HideTip('tt93')">MQTT_Session</a> and removes it from the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link158 onMouseOver="ShowTip(event, 'tt55', 'link158')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscription_fromSession" id=link159 onMouseOver="ShowTip(event, 'tt104', 'link159')" onMouseOut="HideTip('tt104')">f_EPTF_MQTT_subscription_fromSession</a></td><td class=SDescription>Implements part of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link160 onMouseOver="ShowTip(event, 'tt81', 'link160')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM that handles the events coming from the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link161 onMouseOver="ShowTip(event, 'tt93', 'link161')" onMouseOut="HideTip('tt93')">MQTT_Session</a></td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscription_fromEnv" id=link162 onMouseOver="ShowTip(event, 'tt105', 'link162')" onMouseOut="HideTip('tt105')">f_EPTF_MQTT_subscription_fromEnv</a></td><td class=SDescription>Implements part of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link163 onMouseOver="ShowTip(event, 'tt81', 'link163')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM that handles the events coming from the environment</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_subscription_setState" id=link164 onMouseOver="ShowTip(event, 'tt106', 'link164')" onMouseOut="HideTip('tt106')">f_EPTF_MQTT_subscription_setState</a></td><td class=SDescription>Sets a new state of a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link165 onMouseOver="ShowTip(event, 'tt81', 'link165')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_subscription_remove" id=link166 onMouseOver="ShowTip(event, 'tt107', 'link166')" onMouseOut="HideTip('tt107')">f_EPTF_MQTT_subscription_remove</a></td><td class=SDescription>Removing resources related to <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link167 onMouseOver="ShowTip(event, 'tt81', 'link167')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publish_fromSession" id=link168 onMouseOver="ShowTip(event, 'tt108', 'link168')" onMouseOut="HideTip('tt108')">f_EPTF_MQTT_publish_fromSession</a></td><td class=SDescription>Handles a publish transaction in case of QoS 1 and QoS 2 fsm requested by the application layer (e.g. </td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publish_fromEnv" id=link169 onMouseOver="ShowTip(event, 'tt109', 'link169')" onMouseOut="HideTip('tt109')">f_EPTF_MQTT_publish_fromEnv</a></td><td class=SDescription>Handles PUBLISH and publish response (PUB REC/PUB REL/PUB COMP) messages received from the peer (i.e. </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publish_watchdog" id=link170 onMouseOver="ShowTip(event, 'tt110', 'link170')" onMouseOut="HideTip('tt110')">f_EPTF_MQTT_publish_watchdog</a></td><td class=SDescription>Handles the T_watchdog event in the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link171 onMouseOver="ShowTip(event, 'tt69', 'link171')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publish_startT_watchdog" id=link172 onMouseOver="ShowTip(event, 'tt111', 'link172')" onMouseOut="HideTip('tt111')">f_EPTF_MQTT_publish_startT_watchdog</a></td><td class=SDescription>Start a T_watchdog timer in the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link173 onMouseOver="ShowTip(event, 'tt69', 'link173')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publish_setState" id=link174 onMouseOver="ShowTip(event, 'tt112', 'link174')" onMouseOut="HideTip('tt112')">f_EPTF_MQTT_publish_setState</a></td><td class=SDescription>Sets the new state of a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link175 onMouseOver="ShowTip(event, 'tt69', 'link175')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publish_cancelT_watchdog" id=link176 onMouseOver="ShowTip(event, 'tt113', 'link176')" onMouseOut="HideTip('tt113')">f_EPTF_MQTT_publish_cancelT_watchdog</a></td><td class=SDescription>Cancels the T_watchdog timer of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link177 onMouseOver="ShowTip(event, 'tt69', 'link177')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publish_remove" id=link178 onMouseOver="ShowTip(event, 'tt114', 'link178')" onMouseOut="HideTip('tt114')">f_EPTF_MQTT_publish_remove</a></td><td class=SDescription>Releaseing resources of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link179 onMouseOver="ShowTip(event, 'tt69', 'link179')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_setStepCtx" id=link180 onMouseOver="ShowTip(event, 'tt115', 'link180')" onMouseOut="HideTip('tt115')">f_EPTF_MQTT_setStepCtx</a></td><td class=SDescription>Sets the entity and FSM indexes in the MQTT step context</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_setCtx" id=link181 onMouseOver="ShowTip(event, 'tt116', 'link181')" onMouseOut="HideTip('tt116')">f_EPTF_MQTT_setCtx</a></td><td class=SDescription>Sets the instance pointers of <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_StepCtx" class=LType id=link182 onMouseOver="ShowTip(event, 'tt117', 'link182')" onMouseOut="HideTip('tt117')">MQTT_StepCtx</a> to the related instances of a simulated device (entity) and FSM</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_isFsmInitialized" id=link183 onMouseOver="ShowTip(event, 'tt118', 'link183')" onMouseOut="HideTip('tt118')">f_EPTF_MQTT_isFsmInitialized</a></td><td class=SDescription>Checks if an FSM instance has already been initialized</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_getIntValue" id=link184 onMouseOver="ShowTip(event, 'tt119', 'link184')" onMouseOut="HideTip('tt119')">f_EPTF_MQTT_getIntValue</a></td><td class=SDescription>Retreives an element of an <EPTF_IntegerList> if it exists</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_Logging_VERBOSE" id=link185 onMouseOver="ShowTip(event, 'tt120', 'link185')" onMouseOut="HideTip('tt120')">f_EPTF_MQTT_Logging_VERBOSE</a></td><td class=SDescription>Logging functions for the VERBOSE log level</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_Logging_DEBUG" id=link186 onMouseOver="ShowTip(event, 'tt121', 'link186')" onMouseOut="HideTip('tt121')">f_EPTF_MQTT_Logging_DEBUG</a></td><td class=SDescription>Logging functions for the DEBUG log level</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_Logging_WARNING" id=link187 onMouseOver="ShowTip(event, 'tt122', 'link187')" onMouseOut="HideTip('tt122')">f_EPTF_MQTT_Logging_WARNING</a></td><td class=SDescription>Logging functions for the WARNING log level</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_Logging_ERROR" id=link188 onMouseOver="ShowTip(event, 'tt123', 'link188')" onMouseOut="HideTip('tt123')">f_EPTF_MQTT_Logging_ERROR</a></td><td class=SDescription>Logging functions for the ERROR log level</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_dispatchEvent" id=link189 onMouseOver="ShowTip(event, 'tt124', 'link189')" onMouseOut="HideTip('tt124')">f_EPTF_MQTT_dispatchEvent</a></td><td class=SDescription>Dispatches events to an entity/fsm</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_qos_int2enum" id=link190 onMouseOver="ShowTip(event, 'tt125', 'link190')" onMouseOut="HideTip('tt125')">f_EPTF_MQTT_qos_int2enum</a></td><td class=SDescription>Converts the integer value of QoS to its enumerated value</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_EPTF_MQTT_publishResponseType" id=link191 onMouseOver="ShowTip(event, 'tt126', 'link191')" onMouseOut="HideTip('tt126')">f_EPTF_MQTT_publishResponseType</a></td><td class=SDescription>Checks if an MQTT message is a response to a PUBLISH</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_EPTF_MQTT_publishResponsePacketId" id=link192 onMouseOver="ShowTip(event, 'tt127', 'link192')" onMouseOut="HideTip('tt127')">f_EPTF_MQTT_publishResponsePacketId</a></td><td class=SDescription>Get the packet identifier of an MQTT message, if it is a response to a PUBLISH</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_LGen_init"></a>f_EPTF_MQTT_LGen_init</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_LGen_init(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>pl_name</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The main initialization function for the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link194 onMouseOver="ShowTip(event, 'tt2', 'link194')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component type</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_name</td><td class=CDLDescription><b>in</b> <b>charstring</b> - the name for the component instance</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link195 onMouseOver="ShowTip(event, 'tt2', 'link195')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LGen_initLogging"></a>f_EPTF_MQTT_LGen_initLogging</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_LGen_initLogging() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializing CLL’s logging feature on the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link196 onMouseOver="ShowTip(event, 'tt2', 'link196')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component type</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link197 onMouseOver="ShowTip(event, 'tt2', 'link197')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_cleanUp"></a>f_MQTT_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_MQTT_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The main clean up function for the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link198 onMouseOver="ShowTip(event, 'tt2', 'link198')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component type</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link199 onMouseOver="ShowTip(event, 'tt2', 'link199')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_eCtxBind"></a>f_MQTT_eCtxBind</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_eCtxBind(</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_eIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return EPTF_IntegerList</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function is called by the CLL for each entity instance created on a particular instace of <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link200 onMouseOver="ShowTip(event, 'tt2', 'link200')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_eIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the entity instance on this load generator component instance</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry><EPTF_IntegerList></td><td class=CDLDescription>The list will contain the index of the entity the context belongs to</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link201 onMouseOver="ShowTip(event, 'tt2', 'link201')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_eCtxUnbind"></a>f_MQTT_eCtxUnbind</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_MQTT_eCtxUnbind(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The reverse operation of <a href="#f_MQTT_eCtxBind" class=LFunction id=link202 onMouseOver="ShowTip(event, 'tt5', 'link202')" onMouseOut="HideTip('tt5')">f_MQTT_eCtxBind</a>. Cleans up resources reserved during <a href="#f_MQTT_eCtxBind" class=LFunction id=link203 onMouseOver="ShowTip(event, 'tt5', 'link203')" onMouseOut="HideTip('tt5')">f_MQTT_eCtxBind</a>. Called by the CLL.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_eIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the entity instance on this load generator component instance</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link204 onMouseOver="ShowTip(event, 'tt2', 'link204')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_eCtxReset"></a>f_MQTT_eCtxReset</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_MQTT_eCtxReset(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The resources reserved during <a href="#f_MQTT_eCtxBind" class=LFunction id=link205 onMouseOver="ShowTip(event, 'tt5', 'link205')" onMouseOut="HideTip('tt5')">f_MQTT_eCtxBind</a> are reinitalized (reset). Called by the CLL.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_eIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the entity instance on this load generator component instance</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link206 onMouseOver="ShowTip(event, 'tt2', 'link206')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_declareEvents"></a>f_EPTF_MQTT_declareEvents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_declareEvents() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Declares the FSM events to the CLL framework implemented by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link207 onMouseOver="ShowTip(event, 'tt2', 'link207')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link208 onMouseOver="ShowTip(event, 'tt2', 'link208')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_declareSteps"></a>f_EPTF_MQTT_declareSteps</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_declareSteps() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Declares the FSM steps to the CLL framework implemented by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link209 onMouseOver="ShowTip(event, 'tt2', 'link209')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link210 onMouseOver="ShowTip(event, 'tt2', 'link210')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LGen_receiveMessage"></a>f_EPTF_MQTT_LGen_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>function f_EPTF_MQTT_LGen_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 EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The transport layer implementation <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link211 onMouseOver="ShowTip(event, 'tt11', 'link211')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a> can report received <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link212 onMouseOver="ShowTip(event, 'tt12', 'link212')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> message to the load generator layer <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link213 onMouseOver="ShowTip(event, 'tt13', 'link213')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a> extended by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link214 onMouseOver="ShowTip(event, 'tt2', 'link214')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> using this function.</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_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link215 onMouseOver="ShowTip(event, 'tt12', 'link215')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - received message</td></tr></table><h4 class=CHeading>Related Types</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link216 onMouseOver="ShowTip(event, 'tt2', 'link216')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_receiveMessage" class=LType id=link217 onMouseOver="ShowTip(event, 'tt129', 'link217')" onMouseOut="HideTip('tt129')">fcb_EPTF_MQTT_Transport_receiveMessage</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link218 onMouseOver="ShowTip(event, 'tt11', 'link218')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link219 onMouseOver="ShowTip(event, 'tt13', 'link219')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LGen_receiveEvent"></a>f_EPTF_MQTT_LGen_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>function f_EPTF_MQTT_LGen_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 EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The transport layer implementation <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link220 onMouseOver="ShowTip(event, 'tt11', 'link220')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a> can report received <ASP_Event> events to the load generator layer <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link221 onMouseOver="ShowTip(event, 'tt13', 'link221')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a> extended by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link222 onMouseOver="ShowTip(event, 'tt2', 'link222')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> using this function.</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> <ASP_Event> - received event</td></tr></table><h4 class=CHeading>Related Types</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link223 onMouseOver="ShowTip(event, 'tt2', 'link223')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_receiveEvent" class=LType id=link224 onMouseOver="ShowTip(event, 'tt130', 'link224')" onMouseOut="HideTip('tt130')">fcb_EPTF_MQTT_Transport_receiveEvent</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link225 onMouseOver="ShowTip(event, 'tt11', 'link225')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link226 onMouseOver="ShowTip(event, 'tt13', 'link226')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LGen_transportApiResponse"></a>f_EPTF_MQTT_LGen_transportApiResponse</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_LGen_transportApiResponse(</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 EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The transport layer implementation <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link227 onMouseOver="ShowTip(event, 'tt11', 'link227')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a> can report received <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Response" class=LType id=link228 onMouseOver="ShowTip(event, 'tt16', 'link228')" onMouseOut="HideTip('tt16')">EPTF_MQTT_Transport_Response</a> responses to the load generator layer <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link229 onMouseOver="ShowTip(event, 'tt13', 'link229')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a> extended by <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link230 onMouseOver="ShowTip(event, 'tt2', 'link230')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> using this function.</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=link231 onMouseOver="ShowTip(event, 'tt16', 'link231')" onMouseOut="HideTip('tt16')">EPTF_MQTT_Transport_Response</a> - received transport api response</td></tr></table><h4 class=CHeading>Related Types</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link232 onMouseOver="ShowTip(event, 'tt2', 'link232')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_apiResponse" class=LType id=link233 onMouseOver="ShowTip(event, 'tt131', 'link233')" onMouseOut="HideTip('tt131')">fcb_EPTF_MQTT_Transport_apiResponse</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_Provider_CT" class=LType id=link234 onMouseOver="ShowTip(event, 'tt11', 'link234')" onMouseOut="HideTip('tt11')">EPTF_MQTT_Transport_Provider_CT</a></li><li><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_Transport_User_CT" class=LType id=link235 onMouseOver="ShowTip(event, 'tt13', 'link235')" onMouseOut="HideTip('tt13')">EPTF_MQTT_Transport_User_CT</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_LGen_send"></a>f_EPTF_MQTT_LGen_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_LGen_send(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This function is used to send out a message of a <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link236 onMouseOver="ShowTip(event, 'tt12', 'link236')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> using the registered function <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_sendMessage" class=LType id=link237 onMouseOver="ShowTip(event, 'tt18', 'link237')" onMouseOut="HideTip('tt18')">fcb_EPTF_MQTT_Transport_sendMessage</a> of the underlying transport layer instance.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>intout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link238 onMouseOver="ShowTip(event, 'tt12', 'link238')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - the message to be sent</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link239 onMouseOver="ShowTip(event, 'tt12', 'link239')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_init"></a>f_MQTT_step_init</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_step_init(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test Step to dynamically allocate and initialize the MQTT FSM context for the caller FSM. Prerequisite to call any other MQTT test step.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_init" class=LConstant id=link240 onMouseOver="ShowTip(event, 'tt132', 'link240')" onMouseOut="HideTip('tt132')">c_MQTT_stepIdx_init</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_init" class=LConstant id=link241 onMouseOver="ShowTip(event, 'tt133', 'link241')" onMouseOut="HideTip('tt133')">c_MQTT_stepName_init</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_cleanUp"></a>f_MQTT_step_cleanUp</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_step_cleanUp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test Step to free up the MQTT FSM context for the caller FSM. Frees up all allocated instances that were used by this FSM instance.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_cleanUp" class=LConstant id=link242 onMouseOver="ShowTip(event, 'tt134', 'link242')" onMouseOut="HideTip('tt134')">c_MQTT_stepIdx_cleanUp</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_cleanUp" class=LConstant id=link243 onMouseOver="ShowTip(event, 'tt135', 'link243')" onMouseOut="HideTip('tt135')">c_MQTT_stepName_cleanUp</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setLocalAddress_byVars"></a>f_MQTT_step_setLocalAddress_byVars</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_step_setLocalAddress_byVars(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the local address in the entity context.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args (1st param: remoteHost: charstring, 2nd param: remotePort: integer)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setLocalAddress_byVars" class=LConstant id=link244 onMouseOver="ShowTip(event, 'tt136', 'link244')" onMouseOut="HideTip('tt136')">c_MQTT_stepIdx_setLocalAddress_byVars</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setLocalAddress_byVars" class=LConstant id=link245 onMouseOver="ShowTip(event, 'tt137', 'link245')" onMouseOut="HideTip('tt137')">c_MQTT_stepName_setLocalAddress_byVars</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setRemoteAddress_byVars"></a>f_MQTT_step_setRemoteAddress_byVars</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_step_setRemoteAddress_byVars(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the remote address in the FSM context.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args (1st param: remoteHost: charstring, 2nd param: remotePort: integer)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setRemoteAddress_byVars" class=LConstant id=link246 onMouseOver="ShowTip(event, 'tt138', 'link246')" onMouseOut="HideTip('tt138')">c_MQTT_stepIdx_setRemoteAddress_byVars</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setRemoteAddress_byVars" class=LConstant id=link247 onMouseOver="ShowTip(event, 'tt139', 'link247')" onMouseOut="HideTip('tt139')">c_MQTT_stepName_setRemoteAddress_byVars</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_startListening"></a>f_MQTT_step_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_MQTT_step_startListening(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The test step expects that a transport endpoint is set in the addressDB as a local address. The step will initiate allocating the local address associated with the current session in the MQTT context and call the callback function to start listening.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_startListening" class=LConstant id=link248 onMouseOver="ShowTip(event, 'tt140', 'link248')" onMouseOut="HideTip('tt140')">c_MQTT_stepIdx_startListening</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_startListening" class=LConstant id=link249 onMouseOver="ShowTip(event, 'tt141', 'link249')" onMouseOut="HideTip('tt141')">c_MQTT_stepName_startListening</a></li></ul><h4 class=CHeading>Related Steps</h4><ul><li><a href="#f_MQTT_step_setLocalAddress_byVars" class=LFunction id=link250 onMouseOver="ShowTip(event, 'tt21', 'link250')" onMouseOut="HideTip('tt21')">f_MQTT_step_setLocalAddress_byVars</a></li></ul><h4 class=CHeading>Related Callback Function Type</h4><p><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_apiRequest" class=LType id=link251 onMouseOver="ShowTip(event, 'tt142', 'link251')" onMouseOut="HideTip('tt142')">fcb_EPTF_MQTT_Transport_apiRequest</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_transportConnect"></a>f_MQTT_step_transportConnect</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_step_transportConnect(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The test step expects that local and remote socket adresses are set in the addressDB. The step will initiate allocating the local and remote addresses associated with the current session in the MQTT context and call the callback function to establish a connection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_transportConnect" class=LConstant id=link252 onMouseOver="ShowTip(event, 'tt143', 'link252')" onMouseOut="HideTip('tt143')">c_MQTT_stepIdx_transportConnect</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_transportConnect" class=LConstant id=link253 onMouseOver="ShowTip(event, 'tt144', 'link253')" onMouseOut="HideTip('tt144')">c_MQTT_stepName_transportConnect</a></li></ul><h4 class=CHeading>Related Events</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_eventIdx_transportSucc" class=LConstant id=link254 onMouseOver="ShowTip(event, 'tt145', 'link254')" onMouseOut="HideTip('tt145')">c_MQTT_eventIdx_transportSucc</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_eventIdx_transportFail" class=LConstant id=link255 onMouseOver="ShowTip(event, 'tt146', 'link255')" onMouseOut="HideTip('tt146')">c_MQTT_eventIdx_transportFail</a></li></ul><h4 class=CHeading>Related Steps</h4><ul><li><a href="#f_MQTT_step_setLocalAddress_byVars" class=LFunction id=link256 onMouseOver="ShowTip(event, 'tt21', 'link256')" onMouseOut="HideTip('tt21')">f_MQTT_step_setLocalAddress_byVars</a></li></ul><h4 class=CHeading>Related Callback Function Type</h4><p><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_apiRequest" class=LType id=link257 onMouseOver="ShowTip(event, 'tt142', 'link257')" onMouseOut="HideTip('tt142')">fcb_EPTF_MQTT_Transport_apiRequest</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_transportClose"></a>f_MQTT_step_transportClose</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_step_transportClose(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>The test step expects that a transport endpoint is set in the addressDB as a local address. The step will call the callback function to close the connection by the local address associated with the current session in the MQTT context.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args (1st param int: expectResponse (optional))</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_transportClose" class=LConstant id=link258 onMouseOver="ShowTip(event, 'tt147', 'link258')" onMouseOut="HideTip('tt147')">c_MQTT_stepIdx_transportClose</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_transportClose" class=LConstant id=link259 onMouseOver="ShowTip(event, 'tt148', 'link259')" onMouseOut="HideTip('tt148')">c_MQTT_stepName_transportClose</a></li></ul><h4 class=CHeading>Related Steps</h4><ul><li><a href="#f_MQTT_step_startListening" class=LFunction id=link260 onMouseOver="ShowTip(event, 'tt23', 'link260')" onMouseOut="HideTip('tt23')">f_MQTT_step_startListening</a></li><li><a href="#f_MQTT_step_transportConnect" class=LFunction id=link261 onMouseOver="ShowTip(event, 'tt24', 'link261')" onMouseOut="HideTip('tt24')">f_MQTT_step_transportConnect</a></li></ul><h4 class=CHeading>Related Callback Function Type</h4><p><a href="EPTF_MQTT_Transport_Definitions-ttcn.html#fcb_EPTF_MQTT_Transport_apiRequest" class=LType id=link262 onMouseOver="ShowTip(event, 'tt142', 'link262')" onMouseOut="HideTip('tt142')">fcb_EPTF_MQTT_Transport_apiRequest</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_loadTemplate_byIntIdx"></a>f_MQTT_step_loadTemplate_byIntIdx</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_step_loadTemplate_byIntIdx(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to load a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link263 onMouseOver="ShowTip(event, 'tt27', 'link263')" onMouseOut="HideTip('tt27')">MQTT_Template</a> from <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#tsp_EPTF_MQTT_LGen_templates" class=LModuleParameter id=link264 onMouseOver="ShowTip(event, 'tt28', 'link264')" onMouseOut="HideTip('tt28')">tsp_EPTF_MQTT_LGen_templates</a> into <b>v_MQTT_msgToSend</b> (which can be sent using the send test step) by its integer index in test step args.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_loadTemplate_byIntIdx" class=LConstant id=link265 onMouseOver="ShowTip(event, 'tt149', 'link265')" onMouseOut="HideTip('tt149')">c_MQTT_stepIdx_loadTemplate_byIntIdx</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_loadTemplate_byIntIdx" class=LConstant id=link266 onMouseOver="ShowTip(event, 'tt150', 'link266')" onMouseOut="HideTip('tt150')">c_MQTT_stepName_loadTemplate_byIntIdx</a></li></ul><h4 class=CHeading>Related Function</h4><p><a href="#f_MQTT_step_send" class=LFunction id=link267 onMouseOver="ShowTip(event, 'tt41', 'link267')" onMouseOut="HideTip('tt41')">f_MQTT_step_send</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_loadTemplate_byStringId"></a>f_MQTT_step_loadTemplate_byStringId</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_step_loadTemplate_byStringId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to load a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link268 onMouseOver="ShowTip(event, 'tt27', 'link268')" onMouseOut="HideTip('tt27')">MQTT_Template</a> from <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#tsp_EPTF_MQTT_LGen_templates" class=LModuleParameter id=link269 onMouseOver="ShowTip(event, 'tt28', 'link269')" onMouseOut="HideTip('tt28')">tsp_EPTF_MQTT_LGen_templates</a> into <b>v_MQTT_msgToSend</b> (which can be sent using the send test step) by its string Id.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_loadTemplate_byStringId" class=LConstant id=link270 onMouseOver="ShowTip(event, 'tt151', 'link270')" onMouseOut="HideTip('tt151')">c_MQTT_stepIdx_loadTemplate_byStringId</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_loadTemplate_byStringId" class=LConstant id=link271 onMouseOver="ShowTip(event, 'tt152', 'link271')" onMouseOut="HideTip('tt152')">c_MQTT_stepName_loadTemplate_byStringId</a></li></ul><h4 class=CHeading>Related Function</h4><p><a href="#f_MQTT_step_send" class=LFunction id=link272 onMouseOver="ShowTip(event, 'tt41', 'link272')" onMouseOut="HideTip('tt41')">f_MQTT_step_send</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setTopic_stringParam"></a>f_MQTT_step_setTopic_stringParam</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_step_setTopic_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the string value referred by the test step argument as the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(1st param: topic name charstring)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setTopic_stringParam" class=LConstant id=link273 onMouseOver="ShowTip(event, 'tt153', 'link273')" onMouseOut="HideTip('tt153')">c_MQTT_stepIdx_setTopic_stringParam</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setTopic_stringParam" class=LConstant id=link274 onMouseOver="ShowTip(event, 'tt154', 'link274')" onMouseOut="HideTip('tt154')">c_MQTT_stepName_setTopic_stringParam</a></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setTopic_add_stringParam"></a>f_MQTT_step_setTopic_add_stringParam</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_step_setTopic_add_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to add the string value referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(1st param: topic name charstring)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setTopic_add_stringParam" class=LConstant id=link275 onMouseOver="ShowTip(event, 'tt155', 'link275')" onMouseOut="HideTip('tt155')">c_MQTT_stepIdx_setTopic_add_stringParam</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setTopic_add_stringParam" class=LConstant id=link276 onMouseOver="ShowTip(event, 'tt156', 'link276')" onMouseOut="HideTip('tt156')">c_MQTT_stepName_setTopic_add_stringParam</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link277 onMouseOver="ShowTip(event, 'tt2', 'link277')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setTopic_add_varParams"></a>f_MQTT_step_setTopic_add_varParams</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_step_setTopic_add_varParams(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to add the string value of variables referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(params: variables)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setTopic_add_varParams" class=LConstant id=link278 onMouseOver="ShowTip(event, 'tt157', 'link278')" onMouseOut="HideTip('tt157')">c_MQTT_stepIdx_setTopic_add_varParams</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setTopic_add_varParams" class=LConstant id=link279 onMouseOver="ShowTip(event, 'tt158', 'link279')" onMouseOut="HideTip('tt158')">c_MQTT_stepName_setTopic_add_varParams</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link280 onMouseOver="ShowTip(event, 'tt2', 'link280')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setTopic_add_clientId"></a>f_MQTT_step_setTopic_add_clientId</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_step_setTopic_add_clientId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to add client ID in the current session to the topic in the first subscription in SUBSCRIBE and to PUBLISH message.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(param: clientId)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setTopic_add_clientId" class=LConstant id=link281 onMouseOver="ShowTip(event, 'tt159', 'link281')" onMouseOut="HideTip('tt159')">c_MQTT_stepIdx_setTopic_add_clientId</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setTopic_add_clientId" class=LConstant id=link282 onMouseOver="ShowTip(event, 'tt160', 'link282')" onMouseOut="HideTip('tt160')">c_MQTT_stepName_setTopic_add_clientId</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link283 onMouseOver="ShowTip(event, 'tt2', 'link283')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setQos_intParam"></a>f_MQTT_step_setQos_intParam</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_step_setQos_intParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the QoS level in SUBSCRIBE and PUBLISH messages using test step arguments</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(1st param: qos level (0,1,2) integer)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setQos_intParam" class=LConstant id=link284 onMouseOver="ShowTip(event, 'tt161', 'link284')" onMouseOut="HideTip('tt161')">c_MQTT_stepIdx_setQos_intParam</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setQos_intParam" class=LConstant id=link285 onMouseOver="ShowTip(event, 'tt162', 'link285')" onMouseOut="HideTip('tt162')">c_MQTT_stepName_setQos_intParam</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link286 onMouseOver="ShowTip(event, 'tt2', 'link286')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setPublishMessage_stringParam"></a>f_MQTT_step_setPublishMessage_stringParam</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_step_setPublishMessage_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the content of the payload in PUBLISH message.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(1st param: publish message charstring)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setPublishMessage_stringParam" class=LConstant id=link287 onMouseOver="ShowTip(event, 'tt163', 'link287')" onMouseOut="HideTip('tt163')">c_MQTT_stepIdx_setPublishMessage_stringParam</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setPublishMessage_stringParam" class=LConstant id=link288 onMouseOver="ShowTip(event, 'tt164', 'link288')" onMouseOut="HideTip('tt164')">c_MQTT_stepName_setPublishMessage_stringParam</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link289 onMouseOver="ShowTip(event, 'tt2', 'link289')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setPublishMessage_add_stringParam"></a>f_MQTT_step_setPublishMessage_add_stringParam</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_step_setPublishMessage_add_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to concatenate a string to the content of the PUBLISH message</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(1st param: publish message charstring)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setPublishMessage_add_stringParam" class=LConstant id=link290 onMouseOver="ShowTip(event, 'tt165', 'link290')" onMouseOut="HideTip('tt165')">c_MQTT_stepIdx_setPublishMessage_add_stringParam</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setPublishMessage_add_stringParam" class=LConstant id=link291 onMouseOver="ShowTip(event, 'tt166', 'link291')" onMouseOut="HideTip('tt166')">c_MQTT_stepName_setPublishMessage_add_stringParam</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link292 onMouseOver="ShowTip(event, 'tt2', 'link292')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setPublishMessage_add_varParams"></a>f_MQTT_step_setPublishMessage_add_varParams</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_step_setPublishMessage_add_varParams(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to add the content of a set of variables to the payload of a PUBLISH message.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(params: variables)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setPublishMessage_add_varParams" class=LConstant id=link293 onMouseOver="ShowTip(event, 'tt167', 'link293')" onMouseOut="HideTip('tt167')">c_MQTT_stepIdx_setPublishMessage_add_varParams</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setPublishMessage_add_varParams" class=LConstant id=link294 onMouseOver="ShowTip(event, 'tt168', 'link294')" onMouseOut="HideTip('tt168')">c_MQTT_stepName_setPublishMessage_add_varParams</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link295 onMouseOver="ShowTip(event, 'tt2', 'link295')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_setPublishMessage_add_clientId"></a>f_MQTT_step_setPublishMessage_add_clientId</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_step_setPublishMessage_add_clientId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to add client ID of the current session to the payload of a PUBLISH message.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(param: clientId)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_setPublishMessage_add_clientId" class=LConstant id=link296 onMouseOver="ShowTip(event, 'tt169', 'link296')" onMouseOut="HideTip('tt169')">c_MQTT_stepIdx_setPublishMessage_add_clientId</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_setPublishMessage_add_clientId" class=LConstant id=link297 onMouseOver="ShowTip(event, 'tt170', 'link297')" onMouseOut="HideTip('tt170')">c_MQTT_stepName_setPublishMessage_add_clientId</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link298 onMouseOver="ShowTip(event, 'tt2', 'link298')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_reportPingResponse"></a>f_MQTT_step_reportPingResponse</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_step_reportPingResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the report ping response to enable/disable using using step arguments.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args - 1:enable, 0:disable</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_reportPingResponse" class=LConstant id=link299 onMouseOver="ShowTip(event, 'tt171', 'link299')" onMouseOut="HideTip('tt171')">c_MQTT_stepIdx_reportPingResponse</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_reportPingResponse" class=LConstant id=link300 onMouseOver="ShowTip(event, 'tt172', 'link300')" onMouseOut="HideTip('tt172')">c_MQTT_stepName_reportPingResponse</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link301 onMouseOver="ShowTip(event, 'tt2', 'link301')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_reportPublishResponse"></a>f_MQTT_step_reportPublishResponse</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_step_reportPublishResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to set the report publish response to enable/disable using step arguments</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args(1st param: enable (1)/disable (0): integer)</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_reportPublishResponse" class=LConstant id=link302 onMouseOver="ShowTip(event, 'tt173', 'link302')" onMouseOut="HideTip('tt173')">c_MQTT_stepIdx_reportPublishResponse</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_reportPublishResponse" class=LConstant id=link303 onMouseOver="ShowTip(event, 'tt174', 'link303')" onMouseOut="HideTip('tt174')">c_MQTT_stepName_reportPublishResponse</a></li></ul><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link304 onMouseOver="ShowTip(event, 'tt2', 'link304')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_MQTT_step_send"></a>f_MQTT_step_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_MQTT_step_send(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Test step to send out an MQTT message from <b>v_MQTT_msgToSend</b>. The message will be processed by the Applib’s MQTT stack The step expects the localAddress and the remoteAddress to be configured in addressDB.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr></table><h4 class=CHeading>Related Constants</h4><ul><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepIdx_send" class=LConstant id=link305 onMouseOver="ShowTip(event, 'tt175', 'link305')" onMouseOut="HideTip('tt175')">c_MQTT_stepIdx_send</a></li><li><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#c_MQTT_stepName_send" class=LConstant id=link306 onMouseOver="ShowTip(event, 'tt176', 'link306')" onMouseOut="HideTip('tt176')">c_MQTT_stepName_send</a></li></ul><h4 class=CHeading>Related Functions</h4><ul><li><a href="#f_MQTT_step_loadTemplate_byIntIdx" class=LFunction id=link307 onMouseOver="ShowTip(event, 'tt26', 'link307')" onMouseOut="HideTip('tt26')">f_MQTT_step_loadTemplate_byIntIdx</a></li><li><a href="#f_MQTT_step_loadTemplate_byStringId" class=LFunction id=link308 onMouseOver="ShowTip(event, 'tt29', 'link308')" onMouseOut="HideTip('tt29')">f_MQTT_step_loadTemplate_byStringId</a></li></ul><h4 class=CHeading>Related functions</h4><p><a href="#f_EPTF_MQTT_stack_fromApp" class=LFunction id=link309 onMouseOver="ShowTip(event, 'tt88', 'link309')" onMouseOut="HideTip('tt88')">f_EPTF_MQTT_stack_fromApp</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_addressDB_init"></a>f_EPTF_MQTT_addressDB_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_addressDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Function to initialize the addressDB</p><h4 class=CHeading>Parameters</h4><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Address_DB" class=LType id=link310 onMouseOver="ShowTip(event, 'tt177', 'link310')" onMouseOut="HideTip('tt177')">MQTT_Address_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_addressDB_cleanUp"></a>f_EPTF_MQTT_addressDB_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_addressDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Function to clean up the address database and release its resources</p><h4 class=CHeading>Parameters</h4><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Address_DB" class=LType id=link311 onMouseOver="ShowTip(event, 'tt177', 'link311')" onMouseOut="HideTip('tt177')">MQTT_Address_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_addressDB_add"></a>f_EPTF_MQTT_addressDB_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_addressDB_add(</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_addr,</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_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Add a socket address to the addressDB and return its index if no such entry yet, or return its index if already exists</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_addr</td><td class=CDLDescription><b>in</b> <Socket> - socket address</td></tr><tr><td class=CDLEntry>p_idx</td><td class=CDLDescription><b>inout</b> <b>integer</b> - index of the address entry</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Address_DB" class=LType id=link312 onMouseOver="ShowTip(event, 'tt177', 'link312')" onMouseOut="HideTip('tt177')">MQTT_Address_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_addressDB_get"></a>f_EPTF_MQTT_addressDB_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_addressDB_get(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_addr,</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_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Get a socket address from the addressDB by its index</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_addr</td><td class=CDLDescription><b>inout</b> <Socket> - returned socket address</td></tr><tr><td class=CDLEntry>p_idx</td><td class=CDLDescription><b>in</b> <b>integer</b> - index of the address to get</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Address_DB" class=LType id=link313 onMouseOver="ShowTip(event, 'tt177', 'link313')" onMouseOut="HideTip('tt177')">MQTT_Address_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_addressDB_lookUp"></a>f_EPTF_MQTT_addressDB_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_addressDB_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_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Get the index of a socket entry in addressDB</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 address</td></tr></table><h4 class=CHeading>Return Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*integer*</td><td class=CDLDescription>The index of the socket entry</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Address_DB" class=LType id=link314 onMouseOver="ShowTip(event, 'tt177', 'link314')" onMouseOut="HideTip('tt177')">MQTT_Address_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_addressDB_Socket2String"></a>f_EPTF_MQTT_addressDB_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_addressDB_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 a socket address in <Socket> type format to the string format “<IP address>:<port number>” to be used as hash key</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>inout</b> <Socket> - socket address</td></tr></table><h4 class=CHeading>Return Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*charstring*</td><td class=CDLDescription>Socket address in string format</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Address_DB" class=LType id=link315 onMouseOver="ShowTip(event, 'tt177', 'link315')" onMouseOut="HideTip('tt177')">MQTT_Address_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_templateDB_init"></a>f_EPTF_MQTT_templateDB_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_templateDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializes the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link316 onMouseOver="ShowTip(event, 'tt49', 'link316')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database by adding the templates given in <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#tsp_EPTF_MQTT_LGen_templates" class=LModuleParameter id=link317 onMouseOver="ShowTip(event, 'tt28', 'link317')" onMouseOut="HideTip('tt28')">tsp_EPTF_MQTT_LGen_templates</a></p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link318 onMouseOver="ShowTip(event, 'tt49', 'link318')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_templateDB_add"></a>f_EPTF_MQTT_templateDB_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_templateDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Template </td><td class="PParameter prettyprint " nowrap width=100%>p_template</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_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_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link319 onMouseOver="ShowTip(event, 'tt49', 'link319')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_template</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link320 onMouseOver="ShowTip(event, 'tt27', 'link320')" onMouseOut="HideTip('tt27')">MQTT_Template</a> - 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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link321 onMouseOver="ShowTip(event, 'tt49', 'link321')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_templateDB_lookUp"></a>f_EPTF_MQTT_templateDB_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_templateDB_lookUp(</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%>p_id</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link322 onMouseOver="ShowTip(event, 'tt27', 'link322')" onMouseOut="HideTip('tt27')">MQTT_Template</a> element in <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link323 onMouseOver="ShowTip(event, 'tt49', 'link323')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_id</td><td class=CDLDescription><b>in</b> <b>charstring</b> - the id of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template" class=LType id=link324 onMouseOver="ShowTip(event, 'tt27', 'link324')" onMouseOut="HideTip('tt27')">MQTT_Template</a></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 searched template in the database, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link325 onMouseOver="ShowTip(event, 'tt49', 'link325')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_templateDB_get"></a>f_EPTF_MQTT_templateDB_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_templateDB_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>MQTT_v3_1_1_ReqResp </td><td class="PParameter prettyprint " nowrap width=100%>p_pdu</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Retrieves an element from the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link326 onMouseOver="ShowTip(event, 'tt49', 'link326')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> 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_pdu</td><td class=CDLDescription><b>inout</b> <MQTT_v3_1_1_ReqResp> - the retrieved element</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link327 onMouseOver="ShowTip(event, 'tt49', 'link327')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_templateDB_cleanUp"></a>f_EPTF_MQTT_templateDB_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_templateDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cleans up the reserved resources of the <b>v_MQTT_templateDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link328 onMouseOver="ShowTip(event, 'tt49', 'link328')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a> database</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Template_DB" class=LType id=link329 onMouseOver="ShowTip(event, 'tt49', 'link329')" onMouseOut="HideTip('tt49')">MQTT_Template_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_init"></a>f_EPTF_MQTT_sessionDB_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_sessionDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializes the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link330 onMouseOver="ShowTip(event, 'tt55', 'link330')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database and adds its hash to <b>v_MQTT_sessionDB.hashRef</b></p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link331 onMouseOver="ShowTip(event, 'tt55', 'link331')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_cleanUp"></a>f_EPTF_MQTT_sessionDB_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_sessionDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cleans up the reserved resources of the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link332 onMouseOver="ShowTip(event, 'tt55', 'link332')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link333 onMouseOver="ShowTip(event, 'tt55', 'link333')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_add"></a>f_EPTF_MQTT_sessionDB_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_sessionDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Session </td><td class="PParameter prettyprint " nowrap width=100%>p_session</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_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_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link334 onMouseOver="ShowTip(event, 'tt55', 'link334')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_session</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link335 onMouseOver="ShowTip(event, 'tt93', 'link335')" onMouseOut="HideTip('tt93')">MQTT_Session</a> - 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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link336 onMouseOver="ShowTip(event, 'tt55', 'link336')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_setKey"></a>f_EPTF_MQTT_sessionDB_setKey</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_sessionDB_setKey(</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_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets the hash of the local socket address of a session by the session index</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 session index</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link337 onMouseOver="ShowTip(event, 'tt55', 'link337')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_lookUp"></a>f_EPTF_MQTT_sessionDB_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_sessionDB_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_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of a session in <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link338 onMouseOver="ShowTip(event, 'tt55', 'link338')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database by its socket address</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> - the socket address to look up</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, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link339 onMouseOver="ShowTip(event, 'tt55', 'link339')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_get"></a>f_EPTF_MQTT_sessionDB_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_sessionDB_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>MQTT_Session </td><td class="PParameter prettyprint " nowrap width=100%>p_session</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Retrieves a session’s data from the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link340 onMouseOver="ShowTip(event, 'tt55', 'link340')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> 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_session</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link341 onMouseOver="ShowTip(event, 'tt93', 'link341')" onMouseOut="HideTip('tt93')">MQTT_Session</a> - the retrieved session context</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>true if OK, false if no session element with this index</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link342 onMouseOver="ShowTip(event, 'tt55', 'link342')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_check"></a>f_EPTF_MQTT_sessionDB_check</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_sessionDB_check(</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_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Checks if a session element exists in the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link343 onMouseOver="ShowTip(event, 'tt55', 'link343')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> 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 checked</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>true if the session exists</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link344 onMouseOver="ShowTip(event, 'tt55', 'link344')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_remove"></a>f_EPTF_MQTT_sessionDB_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_sessionDB_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_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removes an element from the <b>v_MQTT_sessionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link345 onMouseOver="ShowTip(event, 'tt55', 'link345')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a> database and releases its 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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link346 onMouseOver="ShowTip(event, 'tt55', 'link346')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_sessionDB_addrHash"></a>f_EPTF_MQTT_sessionDB_addrHash</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_sessionDB_addrHash(</td><td class="PTypePrefix prettyprint " nowrap>in </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 a socket address in <Socket> type format to the string format “<IP address>:<port number>” to be used as a hash key</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 address</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>charstring</td><td class=CDLDescription>socket address in string format</td></tr></table></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_init"></a>f_EPTF_MQTT_publishDB_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_publishDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializes the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link347 onMouseOver="ShowTip(event, 'tt65', 'link347')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database and creates its hashmap</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link348 onMouseOver="ShowTip(event, 'tt65', 'link348')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_cleanUp"></a>f_EPTF_MQTT_publishDB_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_publishDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cleans up the reserved resources of the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link349 onMouseOver="ShowTip(event, 'tt65', 'link349')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link350 onMouseOver="ShowTip(event, 'tt65', 'link350')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_add"></a>f_EPTF_MQTT_publishDB_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_publishDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Publish </td><td class="PParameter prettyprint " nowrap width=100%>p_pub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_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_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link351 onMouseOver="ShowTip(event, 'tt65', 'link351')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_pub</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link352 onMouseOver="ShowTip(event, 'tt69', 'link352')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> - 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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link353 onMouseOver="ShowTip(event, 'tt65', 'link353')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_lookUp"></a>f_EPTF_MQTT_publishDB_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_publishDB_lookUp(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link354 onMouseOver="ShowTip(event, 'tt69', 'link354')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> element in <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link355 onMouseOver="ShowTip(event, 'tt65', 'link355')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> database by its session and packet id-s</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session id</td></tr><tr><td class=CDLEntry>p_packetId</td><td class=CDLDescription><b>in</b> <b>integer</b> - input packet 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 searched element in the database, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link356 onMouseOver="ShowTip(event, 'tt65', 'link356')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_get"></a>f_EPTF_MQTT_publishDB_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_publishDB_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>MQTT_Publish </td><td class="PParameter prettyprint " nowrap width=100%>p_pub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Retrieves an element from the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link357 onMouseOver="ShowTip(event, 'tt65', 'link357')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> 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_pub</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link358 onMouseOver="ShowTip(event, 'tt69', 'link358')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> - 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>true: success, false: no element with the index p_idx</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link359 onMouseOver="ShowTip(event, 'tt65', 'link359')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_check"></a>f_EPTF_MQTT_publishDB_check</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_publishDB_check(</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_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Checks if an element exists in the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link360 onMouseOver="ShowTip(event, 'tt65', 'link360')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> 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 checked</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>true: element present, false: element doesn’t exists</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link361 onMouseOver="ShowTip(event, 'tt65', 'link361')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_remove"></a>f_EPTF_MQTT_publishDB_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_publishDB_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_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removes an element from the <b>v_MQTT_publishDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link362 onMouseOver="ShowTip(event, 'tt65', 'link362')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> 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 Removed</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link363 onMouseOver="ShowTip(event, 'tt65', 'link363')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishDB_packetIdHash"></a>f_EPTF_MQTT_publishDB_packetIdHash</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_publishDB_packetIdHash(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Converts a pair of session ID & packet ID to the string format “session_<sessionId>:id_<packetId>” to be used as a hash key</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID</td></tr><tr><td class=CDLEntry>p_packetId</td><td class=CDLDescription><b>in</b> <b>integer</b> - input packet ID</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>charstring</td><td class=CDLDescription>converted IDs</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_DB" class=LType id=link364 onMouseOver="ShowTip(event, 'tt65', 'link364')" onMouseOut="HideTip('tt65')">MQTT_Publish_DB</a> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link365 onMouseOver="ShowTip(event, 'tt2', 'link365')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_init"></a>f_EPTF_MQTT_subscriptionDB_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_subscriptionDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Initializes the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link366 onMouseOver="ShowTip(event, 'tt75', 'link366')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link367 onMouseOver="ShowTip(event, 'tt75', 'link367')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_cleanUp"></a>f_EPTF_MQTT_subscriptionDB_cleanUp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_subscriptionDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cleans up the reserved resources of the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link368 onMouseOver="ShowTip(event, 'tt75', 'link368')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</p><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link369 onMouseOver="ShowTip(event, 'tt75', 'link369')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_add"></a>f_EPTF_MQTT_subscriptionDB_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_subscriptionDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Subscription </td><td class="PParameter prettyprint " nowrap width=100%>p_sub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_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_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link370 onMouseOver="ShowTip(event, 'tt75', 'link370')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sub</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link371 onMouseOver="ShowTip(event, 'tt81', 'link371')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> - 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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link372 onMouseOver="ShowTip(event, 'tt75', 'link372')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_setKey_packetId"></a>f_EPTF_MQTT_subscriptionDB_setKey_packetId</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_subscriptionDB_setKey_packetId(</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>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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Insert an integer element to the subscription hashmap, key is composed from session ID and packet ID</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> - data to be inserted</td></tr><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID, used in hashmap key</td></tr><tr><td class=CDLEntry>p_packetId</td><td class=CDLDescription><b>in</b> <b>integer</b> - input packet ID, used in hashmap key</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link373 onMouseOver="ShowTip(event, 'tt75', 'link373')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_removeKey_packetId"></a>f_EPTF_MQTT_subscriptionDB_removeKey_packetId</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_subscriptionDB_removeKey_packetId(</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>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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><p>Removes the element from the subscription hashmap identified by its session ID and packet ID</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> - NOT USED</td></tr><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID, used in hashmap key</td></tr><tr><td class=CDLEntry>p_packetId</td><td class=CDLDescription><b>in</b> <b>integer</b> - input packet ID, used in hashmap key</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link374 onMouseOver="ShowTip(event, 'tt75', 'link374')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_lookUp_packetId"></a>f_EPTF_MQTT_subscriptionDB_lookUp_packetId</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_subscriptionDB_lookUp_packetId(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link375 onMouseOver="ShowTip(event, 'tt81', 'link375')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> element in <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link376 onMouseOver="ShowTip(event, 'tt75', 'link376')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database by a session ID and packet ID</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID, used in hashmap key</td></tr><tr><td class=CDLEntry>p_packetId</td><td class=CDLDescription><b>in</b> <b>integer</b> - input packet ID, used in hashmap key</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 searched element in the database, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link377 onMouseOver="ShowTip(event, 'tt75', 'link377')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_lookUp_topicName"></a>f_EPTF_MQTT_subscriptionDB_lookUp_topicName</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_subscriptionDB_lookUp_topicName(</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>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_topicName</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Gets the index of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link378 onMouseOver="ShowTip(event, 'tt81', 'link378')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> element in <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link379 onMouseOver="ShowTip(event, 'tt75', 'link379')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> database by a session ID and packet ID</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID, used in hashmap key</td></tr><tr><td class=CDLEntry>p_topicName</td><td class=CDLDescription><b>in</b> <b>charstring</b> - input topic, used in hashmap key</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 searched element in the database, or -1 if not found</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link380 onMouseOver="ShowTip(event, 'tt75', 'link380')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_get"></a>f_EPTF_MQTT_subscriptionDB_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_subscriptionDB_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>MQTT_Subscription </td><td class="PParameter prettyprint " nowrap width=100%>p_sub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Retrieves an element from the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link381 onMouseOver="ShowTip(event, 'tt75', 'link381')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> 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_sub</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link382 onMouseOver="ShowTip(event, 'tt81', 'link382')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> - 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>true: success, false: element with this index doesn’t exist</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link383 onMouseOver="ShowTip(event, 'tt75', 'link383')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_check"></a>f_EPTF_MQTT_subscriptionDB_check</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_subscriptionDB_check(</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_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Checks if an element at an index exists the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link384 onMouseOver="ShowTip(event, 'tt75', 'link384')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> 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 checked</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>true: success, false: element at this index is not present</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link385 onMouseOver="ShowTip(event, 'tt75', 'link385')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_remove"></a>f_EPTF_MQTT_subscriptionDB_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_subscriptionDB_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_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removes an element from the <b>v_MQTT_subscriptionDB</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link386 onMouseOver="ShowTip(event, 'tt75', 'link386')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a> 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 removed</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link387 onMouseOver="ShowTip(event, 'tt75', 'link387')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_packetIdHash"></a>f_EPTF_MQTT_subscriptionDB_packetIdHash</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_subscriptionDB_packetIdHash(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Converts a pair of session ID & packet ID to the string format “session_<sessionId>:id_<packetId>” to be used as hash key</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID</td></tr><tr><td class=CDLEntry>p_packetId</td><td class=CDLDescription><b>in</b> <b>integer</b> - input packet ID</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>charstring</td><td class=CDLDescription>converted IDs</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link388 onMouseOver="ShowTip(event, 'tt75', 'link388')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscriptionDB_topicHash"></a>f_EPTF_MQTT_subscriptionDB_topicHash</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_subscriptionDB_topicHash(</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>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_topic</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Converts a pair of session ID & topic to the string format “session_<sessionId>:topic_<topic>” to be used as hash key</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - input session ID</td></tr><tr><td class=CDLEntry>p_topic</td><td class=CDLDescription><b>in</b> <b>charstring</b> - input topic string</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>charstring</td><td class=CDLDescription>converted IDs</td></tr></table><h4 class=CHeading>Related Type</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_DB" class=LType id=link389 onMouseOver="ShowTip(event, 'tt75', 'link389')" onMouseOut="HideTip('tt75')">MQTT_Subscription_DB</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_stack_fromApp"></a>f_EPTF_MQTT_stack_fromApp</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_stack_fromApp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This is the main entry point for the MQTT stack realization of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link390 onMouseOver="ShowTip(event, 'tt2', 'link390')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component that handles messages received from the application layer (e.g. FSMs)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link391 onMouseOver="ShowTip(event, 'tt12', 'link391')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - message that enters into the stack (will be modified by the stack)</td></tr><tr><td class=CDLEntry>p_ctx</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_StepCtx" class=LType id=link392 onMouseOver="ShowTip(event, 'tt117', 'link392')" onMouseOut="HideTip('tt117')">MQTT_StepCtx</a> - pointers for the instances related to a particular simulated entity</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link393 onMouseOver="ShowTip(event, 'tt2', 'link393')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_stack_fromEnv"></a>f_EPTF_MQTT_stack_fromEnv</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_stack_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This is the main entry point for the MQTT stack realization of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link394 onMouseOver="ShowTip(event, 'tt2', 'link394')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a> component that handles messages received from the environment layer (e.g. transport layer)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link395 onMouseOver="ShowTip(event, 'tt12', 'link395')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - message that enters into the stack (will be modified by the stack)</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link396 onMouseOver="ShowTip(event, 'tt2', 'link396')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_fromApp"></a>f_EPTF_MQTT_session_fromApp</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_session_fromApp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_sIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This is the entry point for an MQTT session fsm handling events coming from the application layer (e.g. client/broker FSMs)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link397 onMouseOver="ShowTip(event, 'tt12', 'link397')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - next transport message to be sent</td></tr><tr><td class=CDLEntry>p_sIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link398 onMouseOver="ShowTip(event, 'tt93', 'link398')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>FSM Diagram of a MQTT session</h4><p>(see EPTF_MQTT_LGen_Functions.MQTT_Session.jpg)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_fromEnv"></a>f_EPTF_MQTT_session_fromEnv</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_session_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_sIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>This is the entry point for an MQTT session fsm from the environment layer (e.g. transport layer)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link399 onMouseOver="ShowTip(event, 'tt12', 'link399')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - transport message received</td></tr><tr><td class=CDLEntry>p_sIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link400 onMouseOver="ShowTip(event, 'tt93', 'link400')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>FSM Diagram of a MQTT session</h4><p>(see EPTF_MQTT_LGen_Functions.MQTT_Session.jpg)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_keepalive"></a>f_EPTF_MQTT_session_keepalive</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_session_keepalive(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_ScheduledAction </td><td class="PParameter prettyprint " nowrap width=100%>pl_action,</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_eventIndex</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Handles the T_keepalive timer event in the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link401 onMouseOver="ShowTip(event, 'tt93', 'link401')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_action</td><td class=CDLDescription><b>inout</b> <EPTF_ScheduledAction> - the scheduled action <></td></tr><tr><td class=CDLEntry>pl_eventIndex</td><td class=CDLDescription><b>in</b> <b>integer</b> - eveny index in the scheduler</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>true <always></td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link402 onMouseOver="ShowTip(event, 'tt93', 'link402')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_startT_keepalive"></a>f_EPTF_MQTT_session_startT_keepalive</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_session_startT_keepalive(</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_sIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>float </td><td class="PParameter prettyprint " nowrap width=100%>pl_time</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Starts the T_keepalive timer for an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link403 onMouseOver="ShowTip(event, 'tt93', 'link403')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_sIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index (?)</td></tr><tr><td class=CDLEntry>pl_time</td><td class=CDLDescription><b>in</b> <b>float</b> - value of the keepalive timer</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>true: succesful , false: 0 or negative timer value</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link404 onMouseOver="ShowTip(event, 'tt93', 'link404')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_cancelT_keepalive"></a>f_EPTF_MQTT_session_cancelT_keepalive</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_session_cancelT_keepalive(</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_sessionIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cancels the T_keepalive timer of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link405 onMouseOver="ShowTip(event, 'tt93', 'link405')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link406 onMouseOver="ShowTip(event, 'tt93', 'link406')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_getNextPacketId"></a>f_EPTF_MQTT_session_getNextPacketId</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_session_getNextPacketId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets the value of the packet id field in the next message to be sent in a session</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_ctx</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_StepCtx" class=LType id=link407 onMouseOver="ShowTip(event, 'tt117', 'link407')" onMouseOut="HideTip('tt117')">MQTT_StepCtx</a> - Pointer of the context embedding the session 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>packet id for the next message</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link408 onMouseOver="ShowTip(event, 'tt93', 'link408')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_setState"></a>f_EPTF_MQTT_session_setState</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_session_setState(</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>in </td><td class="PType prettyprint " nowrap>MQTT_Session_State </td><td class="PParameter prettyprint " nowrap width=100%>p_nextState</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets a new state for an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link409 onMouseOver="ShowTip(event, 'tt93', 'link409')" onMouseOut="HideTip('tt93')">MQTT_Session</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - index of session</td></tr><tr><td class=CDLEntry>p_nextState</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_State" class=LType id=link410 onMouseOver="ShowTip(event, 'tt178', 'link410')" onMouseOut="HideTip('tt178')">MQTT_Session_State</a> - new state of the state machine</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link411 onMouseOver="ShowTip(event, 'tt93', 'link411')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_send"></a>f_EPTF_MQTT_session_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_session_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%>p_sessionIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sends a message to the transort layer with type <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link412 onMouseOver="ShowTip(event, 'tt12', 'link412')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> and the provided session index</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>intout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link413 onMouseOver="ShowTip(event, 'tt12', 'link413')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - the message to be sent</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link414 onMouseOver="ShowTip(event, 'tt93', 'link414')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_registerSubscription"></a>f_EPTF_MQTT_session_registerSubscription</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_session_registerSubscription(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Adds a subscription index to an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link415 onMouseOver="ShowTip(event, 'tt93', 'link415')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - subscription index to add</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link416 onMouseOver="ShowTip(event, 'tt93', 'link416')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_deregisterSubscription"></a>f_EPTF_MQTT_session_deregisterSubscription</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_session_deregisterSubscription(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removes a subscription index from <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link417 onMouseOver="ShowTip(event, 'tt93', 'link417')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - subscription index to remove</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link418 onMouseOver="ShowTip(event, 'tt93', 'link418')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_registerPublish"></a>f_EPTF_MQTT_session_registerPublish</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_session_registerPublish(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Adds a publish index to an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link419 onMouseOver="ShowTip(event, 'tt93', 'link419')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - publish index to add</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link420 onMouseOver="ShowTip(event, 'tt93', 'link420')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_deregisterPublish"></a>f_EPTF_MQTT_session_deregisterPublish</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_session_deregisterPublish(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removes a publish index from an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link421 onMouseOver="ShowTip(event, 'tt93', 'link421')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - publish index to add</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link422 onMouseOver="ShowTip(event, 'tt93', 'link422')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_session_remove"></a>f_EPTF_MQTT_session_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_session_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_sessionIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Releases all resources related to an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link423 onMouseOver="ShowTip(event, 'tt93', 'link423')" onMouseOut="HideTip('tt93')">MQTT_Session</a> and removes it from the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session_DB" class=LType id=link424 onMouseOver="ShowTip(event, 'tt55', 'link424')" onMouseOut="HideTip('tt55')">MQTT_Session_DB</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_sessionIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - session index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link425 onMouseOver="ShowTip(event, 'tt93', 'link425')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscription_fromSession"></a>f_EPTF_MQTT_subscription_fromSession</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_subscription_fromSession(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Implements part of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link426 onMouseOver="ShowTip(event, 'tt81', 'link426')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM that handles the events coming from the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link427 onMouseOver="ShowTip(event, 'tt93', 'link427')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link428 onMouseOver="ShowTip(event, 'tt12', 'link428')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - message that</td></tr><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - subscription index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link429 onMouseOver="ShowTip(event, 'tt81', 'link429')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a></p><h4 class=CHeading>FSM Diagram of a MQTT subscription</h4><p>(see EPTF_MQTT_LGen_Functions.MQTT_Subscription.jpg)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscription_fromEnv"></a>f_EPTF_MQTT_subscription_fromEnv</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_subscription_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Implements part of the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link430 onMouseOver="ShowTip(event, 'tt81', 'link430')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM that handles the events coming from the environment</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link431 onMouseOver="ShowTip(event, 'tt12', 'link431')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - received transport message</td></tr><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - subscription index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link432 onMouseOver="ShowTip(event, 'tt81', 'link432')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a></p><h4 class=CHeading>FSM Diagram of a MQTT subscription</h4><p>(see EPTF_MQTT_LGen_Functions.MQTT_Subscription.jpg)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscription_setState"></a>f_EPTF_MQTT_subscription_setState</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_subscription_setState(</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_subIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Subscription_State </td><td class="PParameter prettyprint " nowrap width=100%>p_nextState</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets a new state of a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link433 onMouseOver="ShowTip(event, 'tt81', 'link433')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - subscription index</td></tr><tr><td class=CDLEntry>p_nextState</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription_State" class=LType id=link434 onMouseOver="ShowTip(event, 'tt179', 'link434')" onMouseOut="HideTip('tt179')">MQTT_Subscription_State</a> - new state in the state machine</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link435 onMouseOver="ShowTip(event, 'tt81', 'link435')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_subscription_remove"></a>f_EPTF_MQTT_subscription_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_subscription_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_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Removing resources related to <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link436 onMouseOver="ShowTip(event, 'tt81', 'link436')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_subIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - subscription index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Subscription" class=LType id=link437 onMouseOver="ShowTip(event, 'tt81', 'link437')" onMouseOut="HideTip('tt81')">MQTT_Subscription</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_fromSession"></a>f_EPTF_MQTT_publish_fromSession</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_publish_fromSession(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Handles a publish transaction in case of QoS 1 and QoS 2 fsm requested by the application layer (e.g. client/broker FSMs)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link438 onMouseOver="ShowTip(event, 'tt12', 'link438')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - transport message</td></tr><tr><td class=CDLEntry>p_pubIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - publish index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link439 onMouseOver="ShowTip(event, 'tt69', 'link439')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p><h4 class=CHeading>FSM Diagram of a MQTT publish</h4><p>(see EPTF_MQTT_LGen_Functions.MQTT_Publish_qos1.jpg)</p><p>(see EPTF_MQTT_LGen_Functions.MQTT_Publish_qos2.jpg)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_fromEnv"></a>f_EPTF_MQTT_publish_fromEnv</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_publish_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Handles PUBLISH and publish response (PUB REC/PUB REL/PUB COMP) messages received from the peer (i.e. from transport layer) based on its QoS and originator</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_Transport_Definitions-ttcn.html#EPTF_MQTT_PDU" class=LType id=link440 onMouseOver="ShowTip(event, 'tt12', 'link440')" onMouseOut="HideTip('tt12')">EPTF_MQTT_PDU</a> - received transport message</td></tr><tr><td class=CDLEntry>p_pubIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - publish index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link441 onMouseOver="ShowTip(event, 'tt69', 'link441')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p><h4 class=CHeading>FSM Diagram of a MQTT publish</h4><p>(see EPTF_MQTT_LGen_Functions.MQTT_Publish_qos1.jpg)</p><p>(see EPTF_MQTT_LGen_Functions.MQTT_Publish_qos2.jpg)</p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_watchdog"></a>f_EPTF_MQTT_publish_watchdog</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_publish_watchdog(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_ScheduledAction </td><td class="PParameter prettyprint " nowrap width=100%>pl_action,</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_eventIndex</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Handles the T_watchdog event in the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link442 onMouseOver="ShowTip(event, 'tt69', 'link442')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_action</td><td class=CDLDescription><b>in</b> <EPTF_ScheduledAction> - scheduled action</td></tr><tr><td class=CDLEntry>pl_eventIndex</td><td class=CDLDescription><b>in</b> <b>integer</b> - event index</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>true <always></td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link443 onMouseOver="ShowTip(event, 'tt69', 'link443')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_startT_watchdog"></a>f_EPTF_MQTT_publish_startT_watchdog</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_publish_startT_watchdog(</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_pIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>float </td><td class="PParameter prettyprint " nowrap width=100%>pl_time</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Start a T_watchdog timer in the <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link444 onMouseOver="ShowTip(event, 'tt69', 'link444')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_pIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - publish transaction index</td></tr><tr><td class=CDLEntry>pl_time</td><td class=CDLDescription><b>in</b> <b>float</b> - time from now when the action takes place</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>true: action scheduled , false: 0 or negative timer value is passed</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link445 onMouseOver="ShowTip(event, 'tt69', 'link445')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_setState"></a>f_EPTF_MQTT_publish_setState</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_publish_setState(</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_pubIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Publish_State </td><td class="PParameter prettyprint " nowrap width=100%>p_nextState</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets the new state of a <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link446 onMouseOver="ShowTip(event, 'tt69', 'link446')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_pubIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - index of the publish FSM in publishDB</td></tr><tr><td class=CDLEntry>p_nextState</td><td class=CDLDescription><b>in</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish_State" class=LType id=link447 onMouseOver="ShowTip(event, 'tt180', 'link447')" onMouseOut="HideTip('tt180')">MQTT_Publish_State</a> - new state of the state machine</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link448 onMouseOver="ShowTip(event, 'tt69', 'link448')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_cancelT_watchdog"></a>f_EPTF_MQTT_publish_cancelT_watchdog</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_publish_cancelT_watchdog(</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_publishIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Cancels the T_watchdog timer of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link449 onMouseOver="ShowTip(event, 'tt69', 'link449')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_publishIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - index of the publish FSM in publishDB</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link450 onMouseOver="ShowTip(event, 'tt69', 'link450')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publish_remove"></a>f_EPTF_MQTT_publish_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_publish_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_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Releaseing resources of an <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link451 onMouseOver="ShowTip(event, 'tt69', 'link451')" onMouseOut="HideTip('tt69')">MQTT_Publish</a> FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_pubIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - publish index</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Publish" class=LType id=link452 onMouseOver="ShowTip(event, 'tt69', 'link452')" onMouseOut="HideTip('tt69')">MQTT_Publish</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_setStepCtx"></a>f_EPTF_MQTT_setStepCtx</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_setStepCtx(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets the entity and FSM indexes in the MQTT step context</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_ptr</td><td class=CDLDescription><b>in</b> <EPTF_LGenBase_TestStepArgs> - test step args</td></tr><tr><td class=CDLEntry>p_ctx</td><td class=CDLDescription><b>inout</b> <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_StepCtx" class=LType id=link453 onMouseOver="ShowTip(event, 'tt117', 'link453')" onMouseOut="HideTip('tt117')">MQTT_StepCtx</a> - returns MQTT step context</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 successful?</td></tr></table><h4 class=CHeading>Related Function</h4><p><a href="#f_MQTT_step_init" class=LFunction id=link454 onMouseOver="ShowTip(event, 'tt19', 'link454')" onMouseOut="HideTip('tt19')">f_MQTT_step_init</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_setCtx"></a>f_EPTF_MQTT_setCtx</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_setCtx(</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_eIdx,</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_fsmIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Sets the instance pointers of <a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_StepCtx" class=LType id=link455 onMouseOver="ShowTip(event, 'tt117', 'link455')" onMouseOut="HideTip('tt117')">MQTT_StepCtx</a> to the related instances of a simulated device (entity) and FSM</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_eIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - entity index</td></tr><tr><td class=CDLEntry>p_fsmIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - FSM index</td></tr><tr><td class=CDLEntry>p_ctx</td><td class=CDLDescription><b>inout</b> MQTT_StepCtx - returned context value</td></tr></table><h4 class=CHeading>Related Functions</h4><p><a href="#f_MQTT_step_init" class=LFunction id=link456 onMouseOver="ShowTip(event, 'tt19', 'link456')" onMouseOut="HideTip('tt19')">f_MQTT_step_init</a></p><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_StepCtx" class=LType id=link457 onMouseOver="ShowTip(event, 'tt117', 'link457')" onMouseOut="HideTip('tt117')">MQTT_StepCtx</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_isFsmInitialized"></a>f_EPTF_MQTT_isFsmInitialized</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_isFsmInitialized(</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_eIdx,</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_fsmIdx,</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%>pl_sessionIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Checks if an FSM instance has already been initialized</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_eIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - entity index</td></tr><tr><td class=CDLEntry>p_fsmIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - FSM index</td></tr><tr><td class=CDLEntry>pl_sessionIdx</td><td class=CDLDescription><b>inout</b> <b>integer</b> - returns session index if initialized, -1 if not</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>true: initialized, false: not initialized</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#MQTT_Session" class=LType id=link458 onMouseOver="ShowTip(event, 'tt93', 'link458')" onMouseOut="HideTip('tt93')">MQTT_Session</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_getIntValue"></a>f_EPTF_MQTT_getIntValue</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_getIntValue(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_intList,</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_number,</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%>pl_value</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Retreives an element of an <EPTF_IntegerList> if it exists</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_intList</td><td class=CDLDescription><b>in</b> <EPTF_IntegerList> - list of integers</td></tr><tr><td class=CDLEntry>pl_number</td><td class=CDLDescription><b>in</b> <b>integer</b> - index of the integer to be retrieved</td></tr><tr><td class=CDLEntry>pl_value</td><td class=CDLDescription><b>inout</b> <b>integer</b> - returns the value of the retrieved integer</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>true if the element exists in the integer list</td></tr></table></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_Logging_VERBOSE"></a>f_EPTF_MQTT_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_EPTF_MQTT_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_LGen_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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link459 onMouseOver="ShowTip(event, 'tt2', 'link459')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_Logging_DEBUG"></a>f_EPTF_MQTT_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_EPTF_MQTT_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_LGen_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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link460 onMouseOver="ShowTip(event, 'tt2', 'link460')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_Logging_WARNING"></a>f_EPTF_MQTT_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_EPTF_MQTT_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_LGen_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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link461 onMouseOver="ShowTip(event, 'tt2', 'link461')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_Logging_ERROR"></a>f_EPTF_MQTT_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_EPTF_MQTT_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_LGen_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><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link462 onMouseOver="ShowTip(event, 'tt2', 'link462')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_dispatchEvent"></a>f_EPTF_MQTT_dispatchEvent</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_dispatchEvent(</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_eventIdx,</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_eIdx,</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_fsmCtx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_reportedArgs</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Dispatches events to an entity/fsm</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_eventIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - index of the event</td></tr><tr><td class=CDLEntry>pl_eIdx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of the entity</td></tr><tr><td class=CDLEntry>pl_fsmCtx</td><td class=CDLDescription><b>in</b> <b>integer</b> - the index of FSM</td></tr><tr><td class=CDLEntry>pl_reportedArgs</td><td class=CDLDescription><b>in</b> <EPTF_IntegerList> - additional arguments to be reported to the entity/FSM</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link463 onMouseOver="ShowTip(event, 'tt2', 'link463')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_qos_int2enum"></a>f_EPTF_MQTT_qos_int2enum</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_qos_int2enum(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>p_qos</td><td class="PAfterParameters prettyprint "nowrap>) return QoS</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Converts the integer value of QoS to its enumerated value</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_qos</td><td class=CDLDescription><b>in</b> <b>integer</b> - integer QoS value</td></tr></table><h4 class=CHeading>Return Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry><QoS></td><td class=CDLDescription>enumerated value of the input QoS</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link464 onMouseOver="ShowTip(event, 'tt2', 'link464')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishResponseType"></a>f_EPTF_MQTT_publishResponseType</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_publishResponseType(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_v3_1_1_ReqResp </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return boolean</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Checks if an MQTT message is a response to a PUBLISH</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>in</b> <MQTT_v3_1_1_ReqResp> - the MQTT message to be checked</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>true: message is a publish response type message</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="EPTF_MQTT_LGen_Definitions-ttcn.html#EPTF_MQTT_LGen_CT" class=LType id=link465 onMouseOver="ShowTip(event, 'tt2', 'link465')" onMouseOut="HideTip('tt2')">EPTF_MQTT_LGen_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_EPTF_MQTT_publishResponsePacketId"></a>f_EPTF_MQTT_publishResponsePacketId</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_publishResponsePacketId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_v3_1_1_ReqResp </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return integer</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Get the packet identifier of an MQTT message, if it is a response to a PUBLISH</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p_msg</td><td class=CDLDescription><b>in</b> <MQTT_v3_1_1_ReqResp> - the input MQTT message</td></tr></table><h4 class=CHeading>Return Type</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>*integer*</td><td class=CDLDescription>Packet identifier value if the message was of a PUBLISH response type, -1 in other cases</td></tr></table></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><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function f_EPTF_MQTT_LGen_init(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap>pl_name</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The main initialization function for the EPTF_MQTT_LGen_CT component type</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 component EPTF_MQTT_LGen_CT extends EPTF_MQTT_Transport_User_CT, EPTF_LGenBase_CT, EPTF_Logging_CT</td></tr></table></blockquote>MQTT load generator component</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_LGen_initLogging() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Initializing CLL’s logging feature on the EPTF_MQTT_LGen_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_MQTT_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>The main clean up function for the EPTF_MQTT_LGen_CT component type</div></div><div class=CToolTip id="tt5"><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_eCtxBind(</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_eIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return EPTF_IntegerList</td></tr></table></td></tr></table></blockquote>This function is called by the CLL for each entity instance created on a particular instace of EPTF_MQTT_LGen_CT</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 "nowrap>function f_MQTT_eCtxUnbind(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The reverse operation of f_MQTT_eCtxBind. </div></div><div class=CToolTip id="tt7"><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_MQTT_eCtxReset(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>pl_eIdx</td><td class="PAfterParameters prettyprint "nowrap>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The resources reserved during f_MQTT_eCtxBind are reinitalized (reset). </div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_declareEvents() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Declares the FSM events to the CLL framework implemented by EPTF_MQTT_LGen_CT</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_declareSteps() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Declares the FSM steps to the CLL framework implemented by EPTF_MQTT_LGen_CT</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_LGen_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 EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The transport layer implementation EPTF_MQTT_Transport_Provider_CT can report received EPTF_MQTT_PDU message to the load generator layer EPTF_MQTT_Transport_User_CT extended by EPTF_MQTT_LGen_CT using this function.</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 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="tt12"><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="tt13"><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="tt14"><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_LGen_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 EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The transport layer implementation EPTF_MQTT_Transport_Provider_CT can report received ASP_Event events to the load generator layer EPTF_MQTT_Transport_User_CT extended by EPTF_MQTT_LGen_CT using this function.</div></div><div class=CToolTip id="tt15"><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_LGen_transportApiResponse(</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 EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The transport layer implementation EPTF_MQTT_Transport_Provider_CT can report received EPTF_MQTT_Transport_Response responses to the load generator layer EPTF_MQTT_Transport_User_CT extended by EPTF_MQTT_LGen_CT using this function.</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 record EPTF_MQTT_Transport_Response</td></tr></table></blockquote>Type for transport response</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_LGen_send(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>This function is used to send out a message of a EPTF_MQTT_PDU using the registered function fcb_EPTF_MQTT_Transport_sendMessage of the underlying transport layer instance.</div></div><div class=CToolTip id="tt18"><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="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_MQTT_step_init(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test Step to dynamically allocate and initialize the MQTT FSM context for the caller FSM. </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_MQTT_step_cleanUp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test Step to free up the MQTT FSM context for the caller FSM. </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 "colspan=4>function f_MQTT_step_setLocalAddress_byVars(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the local address in the entity context.</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_step_setRemoteAddress_byVars(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the remote address in the FSM context.</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_step_startListening(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The test step expects that a transport endpoint is set in the addressDB as a local address. </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_step_transportConnect(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The test step expects that local and remote socket adresses are set in the addressDB. </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_step_transportClose(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>The test step expects that a transport endpoint is set in the addressDB as a local address. </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_MQTT_step_loadTemplate_byIntIdx(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to load a MQTT_Template from tsp_EPTF_MQTT_LGen_templates into <b>v_MQTT_msgToSend</b> (which can be sent using the send test step) by its integer index in test step args.</div></div><div class=CToolTip id="tt27"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Template</td></tr></table></blockquote>Grouping a MQTT_v3_1_1_ReqResp with an id</div></div><div class=CToolTip id="tt28"><div class=CModuleParameter>MQTT message template definitions for sending</div></div><div class=CToolTip id="tt29"><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_step_loadTemplate_byStringId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to load a MQTT_Template from tsp_EPTF_MQTT_LGen_templates into <b>v_MQTT_msgToSend</b> (which can be sent using the send test step) by its string Id.</div></div><div class=CToolTip id="tt30"><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_step_setTopic_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the string value referred by the test step argument as the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</div></div><div class=CToolTip id="tt31"><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_step_setTopic_add_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to add the string value referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</div></div><div class=CToolTip id="tt32"><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_step_setTopic_add_varParams(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to add the string value of variables referred by the test step argument to the topic of the first subscription entry in SUBSCRIBE and PUBLISH messages.</div></div><div class=CToolTip id="tt33"><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_step_setTopic_add_clientId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to add client ID in the current session to the topic in the first subscription in SUBSCRIBE and to PUBLISH message.</div></div><div class=CToolTip id="tt34"><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_step_setQos_intParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the QoS level in SUBSCRIBE and PUBLISH messages using test step arguments</div></div><div class=CToolTip id="tt35"><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_step_setPublishMessage_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the content of the payload in PUBLISH message.</div></div><div class=CToolTip id="tt36"><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_step_setPublishMessage_add_stringParam(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to concatenate a string to the content of the PUBLISH message</div></div><div class=CToolTip id="tt37"><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_step_setPublishMessage_add_varParams(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to add the content of a set of variables to the payload of a PUBLISH message.</div></div><div class=CToolTip id="tt38"><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_step_setPublishMessage_add_clientId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to add client ID of the current session to the payload of a PUBLISH message.</div></div><div class=CToolTip id="tt39"><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_step_reportPingResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the report ping response to enable/disable using using step arguments.</div></div><div class=CToolTip id="tt40"><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_step_reportPublishResponse(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to set the report publish response to enable/disable using step arguments</div></div><div class=CToolTip id="tt41"><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_step_send(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Test step to send out an MQTT message from <b>v_MQTT_msgToSend</b>. </div></div><div class=CToolTip id="tt42"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_addressDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Function to initialize the addressDB</div></div><div class=CToolTip id="tt43"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_addressDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Function to clean up the address database and release its resources</div></div><div class=CToolTip id="tt44"><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_addressDB_add(</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_addr,</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_LGen_CT</td></tr></table></td></tr></table></blockquote>Add a socket address to the addressDB and return its index if no such entry yet, or return its index if already exists</div></div><div class=CToolTip id="tt45"><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_addressDB_get(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>Socket </td><td class="PParameter prettyprint " nowrap width=100%>p_addr,</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_LGen_CT</td></tr></table></td></tr></table></blockquote>Get a socket address from the addressDB by its index</div></div><div class=CToolTip id="tt46"><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_addressDB_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_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Get the index of a socket entry in addressDB</div></div><div class=CToolTip id="tt47"><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_addressDB_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 a socket address in Socket type format to the string format “IP address:<port number>” to be used as hash key</div></div><div class=CToolTip id="tt48"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_templateDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Initializes the <b>v_MQTT_templateDB</b> MQTT_Template_DB database by adding the templates given in tsp_EPTF_MQTT_LGen_templates</div></div><div class=CToolTip id="tt49"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Template_DB</td></tr></table></blockquote>Storing MQTT_Template instances</div></div><div class=CToolTip id="tt50"><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_templateDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Template </td><td class="PParameter prettyprint " nowrap width=100%>p_template</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Adds a new element to the <b>v_MQTT_templateDB</b> MQTT_Template_DB database</div></div><div class=CToolTip id="tt51"><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_templateDB_lookUp(</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%>p_id</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of an MQTT_Template element in <b>v_MQTT_templateDB</b> MQTT_Template_DB database</div></div><div class=CToolTip id="tt52"><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_templateDB_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>MQTT_v3_1_1_ReqResp </td><td class="PParameter prettyprint " nowrap width=100%>p_pdu</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Retrieves an element from the <b>v_MQTT_templateDB</b> MQTT_Template_DB database</div></div><div class=CToolTip id="tt53"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_templateDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Cleans up the reserved resources of the <b>v_MQTT_templateDB</b> MQTT_Template_DB database</div></div><div class=CToolTip id="tt54"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_sessionDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Initializes the <b>v_MQTT_sessionDB</b> MQTT_Session_DB database and adds its hash to <b>v_MQTT_sessionDB.hashRef</b></div></div><div class=CToolTip id="tt55"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Session_DB</td></tr></table></blockquote>Storing MQTT_Session instances</div></div><div class=CToolTip id="tt56"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_sessionDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Cleans up the reserved resources of the <b>v_MQTT_sessionDB</b> MQTT_Session_DB database</div></div><div class=CToolTip id="tt57"><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_sessionDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Session </td><td class="PParameter prettyprint " nowrap width=100%>p_session</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Adds a new element to the <b>v_MQTT_sessionDB</b> MQTT_Session_DB database</div></div><div class=CToolTip id="tt58"><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_sessionDB_setKey(</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_LGen_CT</td></tr></table></td></tr></table></blockquote>Sets the hash of the local socket address of a session by the session index</div></div><div class=CToolTip id="tt59"><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_sessionDB_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_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of a session in <b>v_MQTT_sessionDB</b> MQTT_Session_DB database by its socket address</div></div><div class=CToolTip id="tt60"><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_sessionDB_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>MQTT_Session </td><td class="PParameter prettyprint " nowrap width=100%>p_session</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Retrieves a session’s data from the <b>v_MQTT_sessionDB</b> MQTT_Session_DB database</div></div><div class=CToolTip id="tt61"><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_sessionDB_check(</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_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Checks if a session element exists in the <b>v_MQTT_sessionDB</b> MQTT_Session_DB database</div></div><div class=CToolTip id="tt62"><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_sessionDB_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Removes an element from the <b>v_MQTT_sessionDB</b> MQTT_Session_DB database and releases its resources</div></div><div class=CToolTip id="tt63"><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_sessionDB_addrHash(</td><td class="PTypePrefix prettyprint " nowrap>in </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 a socket address in Socket type format to the string format “IP address:<port number>” to be used as a hash key</div></div><div class=CToolTip id="tt64"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_publishDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Initializes the <b>v_MQTT_publishDB</b> MQTT_Publish_DB database and creates its hashmap</div></div><div class=CToolTip id="tt65"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Publish_DB</td></tr></table></blockquote>Storing MQTT_Publish instances</div></div><div class=CToolTip id="tt66"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_publishDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Cleans up the reserved resources of the <b>v_MQTT_publishDB</b> MQTT_Publish_DB database</div></div><div class=CToolTip id="tt67"><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_publishDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Publish </td><td class="PParameter prettyprint " nowrap width=100%>p_pub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Adds a new element to the <b>v_MQTT_publishDB</b> MQTT_Publish_DB database</div></div><div class=CToolTip id="tt68"><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_publishDB_lookUp(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of an MQTT_Publish element in <b>v_MQTT_publishDB</b> MQTT_Publish_DB database by its session and packet id-s</div></div><div class=CToolTip id="tt69"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Publish</td></tr></table></blockquote>Models an MQTT publish</div></div><div class=CToolTip id="tt70"><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_publishDB_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>MQTT_Publish </td><td class="PParameter prettyprint " nowrap width=100%>p_pub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Retrieves an element from the <b>v_MQTT_publishDB</b> MQTT_Publish_DB database</div></div><div class=CToolTip id="tt71"><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_publishDB_check(</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_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Checks if an element exists in the <b>v_MQTT_publishDB</b> MQTT_Publish_DB database</div></div><div class=CToolTip id="tt72"><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_publishDB_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Removes an element from the <b>v_MQTT_publishDB</b> MQTT_Publish_DB database</div></div><div class=CToolTip id="tt73"><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_publishDB_packetIdHash(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote>Converts a pair of session ID & packet ID to the string format “session_sessionId:id_packetId” to be used as a hash key</div></div><div class=CToolTip id="tt74"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_subscriptionDB_init() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Initializes the <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database</div></div><div class=CToolTip id="tt75"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Subscription_DB</td></tr></table></blockquote>Storing MQTT_Subscription instances</div></div><div class=CToolTip id="tt76"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_MQTT_subscriptionDB_cleanUp() runs on EPTF_MQTT_LGen_CT</td></tr></table></blockquote>Cleans up the reserved resources of the <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database</div></div><div class=CToolTip id="tt77"><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_subscriptionDB_add(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Subscription </td><td class="PParameter prettyprint " nowrap width=100%>p_sub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Adds a new element to the <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database</div></div><div class=CToolTip id="tt78"><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_subscriptionDB_setKey_packetId(</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>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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Insert an integer element to the subscription hashmap, key is composed from session ID and packet ID</div></div><div class=CToolTip id="tt79"><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_subscriptionDB_removeKey_packetId(</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>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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Removes the element from the subscription hashmap identified by its session ID and packet ID</div></div><div class=CToolTip id="tt80"><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_subscriptionDB_lookUp_packetId(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of an MQTT_Subscription element in <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database by a session ID and packet ID</div></div><div class=CToolTip id="tt81"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Subscription</td></tr></table></blockquote>Models an MQTT subscription</div></div><div class=CToolTip id="tt82"><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_subscriptionDB_lookUp_topicName(</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>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_topicName</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Gets the index of an MQTT_Subscription element in <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database by a session ID and packet ID</div></div><div class=CToolTip id="tt83"><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_subscriptionDB_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>MQTT_Subscription </td><td class="PParameter prettyprint " nowrap width=100%>p_sub</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Retrieves an element from the <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database</div></div><div class=CToolTip id="tt84"><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_subscriptionDB_check(</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_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Checks if an element at an index exists the <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database</div></div><div class=CToolTip id="tt85"><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_subscriptionDB_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Removes an element from the <b>v_MQTT_subscriptionDB</b> MQTT_Subscription_DB database</div></div><div class=CToolTip id="tt86"><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_subscriptionDB_packetIdHash(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_packetId</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote>Converts a pair of session ID & packet ID to the string format “session_sessionId:id_packetId” to be used as hash key</div></div><div class=CToolTip id="tt87"><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_subscriptionDB_topicHash(</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>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>p_topic</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote>Converts a pair of session ID & topic to the string format “session_sessionId:topic_topic” to be used as hash key</div></div><div class=CToolTip id="tt88"><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_stack_fromApp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>This is the main entry point for the MQTT stack realization of the EPTF_MQTT_LGen_CT component that handles messages received from the application layer (e.g. </div></div><div class=CToolTip id="tt89"><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_stack_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>This is the main entry point for the MQTT stack realization of the EPTF_MQTT_LGen_CT component that handles messages received from the environment layer (e.g. </div></div><div class=CToolTip id="tt90"><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_session_fromApp(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_sIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>This is the entry point for an MQTT session fsm handling events coming from the application layer (e.g. </div></div><div class=CToolTip id="tt91"><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_session_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_sIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>This is the entry point for an MQTT session fsm from the environment layer (e.g. </div></div><div class=CToolTip id="tt92"><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_session_keepalive(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_ScheduledAction </td><td class="PParameter prettyprint " nowrap width=100%>pl_action,</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_eventIndex</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Handles the T_keepalive timer event in the MQTT_Session FSM</div></div><div class=CToolTip id="tt93"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Session</td></tr></table></blockquote>Models and MQTT session</div></div><div class=CToolTip id="tt94"><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_session_startT_keepalive(</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_sIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>float </td><td class="PParameter prettyprint " nowrap width=100%>pl_time</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Starts the T_keepalive timer for an MQTT_Session FSM</div></div><div class=CToolTip id="tt95"><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_session_cancelT_keepalive(</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_sessionIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Cancels the T_keepalive timer of an MQTT_Session FSM</div></div><div class=CToolTip id="tt96"><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_session_getNextPacketId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return integer</td></tr></table></td></tr></table></blockquote>Sets the value of the packet id field in the next message to be sent in a session</div></div><div class=CToolTip id="tt97"><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_session_setState(</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>in </td><td class="PType prettyprint " nowrap>MQTT_Session_State </td><td class="PParameter prettyprint " nowrap width=100%>p_nextState</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Sets a new state for an MQTT_Session FSM</div></div><div class=CToolTip id="tt98"><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_session_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%>p_sessionIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Sends a message to the transort layer with type EPTF_MQTT_PDU and the provided session index</div></div><div class=CToolTip id="tt99"><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_session_registerSubscription(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Adds a subscription index to an MQTT_Session</div></div><div class=CToolTip id="tt100"><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_session_deregisterSubscription(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Removes a subscription index from MQTT_Session</div></div><div class=CToolTip id="tt101"><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_session_registerPublish(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Adds a publish index to an MQTT_Session</div></div><div class=CToolTip id="tt102"><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_session_deregisterPublish(</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>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap width=100%>p_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Removes a publish index from an MQTT_Session</div></div><div class=CToolTip id="tt103"><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_session_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_sessionIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Releases all resources related to an MQTT_Session and removes it from the MQTT_Session_DB</div></div><div class=CToolTip id="tt104"><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_subscription_fromSession(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Implements part of the MQTT_Subscription FSM that handles the events coming from the MQTT_Session</div></div><div class=CToolTip id="tt105"><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_subscription_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Implements part of the MQTT_Subscription FSM that handles the events coming from the environment</div></div><div class=CToolTip id="tt106"><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_subscription_setState(</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_subIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Subscription_State </td><td class="PParameter prettyprint " nowrap width=100%>p_nextState</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Sets a new state of a MQTT_Subscription FSM</div></div><div class=CToolTip id="tt107"><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_subscription_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_subIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Removing resources related to MQTT_Subscription FSM</div></div><div class=CToolTip id="tt108"><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_publish_fromSession(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Handles a publish transaction in case of QoS 1 and QoS 2 fsm requested by the application layer (e.g. </div></div><div class=CToolTip id="tt109"><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_publish_fromEnv(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>EPTF_MQTT_PDU </td><td class="PParameter prettyprint " nowrap width=100%>p_msg,</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_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Handles PUBLISH and publish response (PUB REC/PUB REL/PUB COMP) messages received from the peer (i.e. </div></div><div class=CToolTip id="tt110"><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_publish_watchdog(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_ScheduledAction </td><td class="PParameter prettyprint " nowrap width=100%>pl_action,</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_eventIndex</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Handles the T_watchdog event in the MQTT_Publish FSM</div></div><div class=CToolTip id="tt111"><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_publish_startT_watchdog(</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_pIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>float </td><td class="PParameter prettyprint " nowrap width=100%>pl_time</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Start a T_watchdog timer in the MQTT_Publish FSM</div></div><div class=CToolTip id="tt112"><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_publish_setState(</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_pubIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_Publish_State </td><td class="PParameter prettyprint " nowrap width=100%>p_nextState</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Sets the new state of a MQTT_Publish FSM</div></div><div class=CToolTip id="tt113"><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_publish_cancelT_watchdog(</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_publishIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Cancels the T_watchdog timer of an MQTT_Publish FSM</div></div><div class=CToolTip id="tt114"><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_publish_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_pubIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Releaseing resources of an MQTT_Publish FSM</div></div><div class=CToolTip id="tt115"><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_setStepCtx(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_LGenBase_TestStepArgs </td><td class="PParameter prettyprint " nowrap width=100%>pl_ptr,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Sets the entity and FSM indexes in the MQTT step context</div></div><div class=CToolTip id="tt116"><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_setCtx(</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_eIdx,</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_fsmIdx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>inout </td><td class="PType prettyprint " nowrap>MQTT_StepCtx </td><td class="PParameter prettyprint " nowrap width=100%>p_ctx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Sets the instance pointers of MQTT_StepCtx to the related instances of a simulated device (entity) and FSM</div></div><div class=CToolTip id="tt117"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_StepCtx</td></tr></table></blockquote>Type that stores the most important pointers</div></div><div class=CToolTip id="tt118"><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_isFsmInitialized(</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_eIdx,</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_fsmIdx,</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%>pl_sessionIdx</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT return boolean</td></tr></table></td></tr></table></blockquote>Checks if an FSM instance has already been initialized</div></div><div class=CToolTip id="tt119"><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_getIntValue(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_intList,</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_number,</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%>pl_value</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return boolean</td></tr></table></td></tr></table></blockquote>Retreives an element of an EPTF_IntegerList if it exists</div></div><div class=CToolTip id="tt120"><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_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the VERBOSE log level</div></div><div class=CToolTip id="tt121"><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_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the DEBUG log level</div></div><div class=CToolTip id="tt122"><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_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the WARNING log level</div></div><div class=CToolTip id="tt123"><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_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_LGen_CT</td></tr></table></td></tr></table></blockquote>Logging functions for the ERROR log level</div></div><div class=CToolTip id="tt124"><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_dispatchEvent(</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_eventIdx,</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_eIdx,</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_fsmCtx,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_IntegerList </td><td class="PParameter prettyprint " nowrap width=100%>pl_reportedArgs</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_MQTT_LGen_CT</td></tr></table></td></tr></table></blockquote>Dispatches events to an entity/fsm</div></div><div class=CToolTip id="tt125"><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_qos_int2enum(</td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>integer </td><td class="PParameter prettyprint " nowrap>p_qos</td><td class="PAfterParameters prettyprint "nowrap>) return QoS</td></tr></table></td></tr></table></blockquote>Converts the integer value of QoS to its enumerated value</div></div><div class=CToolTip id="tt126"><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_publishResponseType(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_v3_1_1_ReqResp </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return boolean</td></tr></table></td></tr></table></blockquote>Checks if an MQTT message is a response to a PUBLISH</div></div><div class=CToolTip id="tt127"><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_publishResponsePacketId(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>MQTT_v3_1_1_ReqResp </td><td class="PParameter prettyprint " nowrap width=100%>p_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return integer</td></tr></table></td></tr></table></blockquote>Get the packet identifier of an MQTT message, if it is a response to a PUBLISH</div></div><div class=CToolTip id="tt128"><div class=CFile>This module contains the definitions for the MQTT load generator component</div></div><div class=CToolTip id="tt129"><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="tt130"><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="tt131"><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="tt132"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_init := 0</td></tr></table></blockquote>Integer constant for the MQTT init test step</div></div><div class=CToolTip id="tt133"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_init := "MQTT Applib: init"</td></tr></table></blockquote>Charstring constant for the MQTT init test step</div></div><div class=CToolTip id="tt134"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_cleanUp := 1</td></tr></table></blockquote>Integer constant for the MQTT clean up test step</div></div><div class=CToolTip id="tt135"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_cleanUp := "MQTT Applib: cleanUp"</td></tr></table></blockquote>Charstring constant for the MQTT clean up test step</div></div><div class=CToolTip id="tt136"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setLocalAddress_byVars := 2</td></tr></table></blockquote>Integer constant for the MQTT set local address by variables test step</div></div><div class=CToolTip id="tt137"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setLocalAddress_byVars := "MQTT Applib: setLocalAddress_byVars"</td></tr></table></blockquote>Integer constant for the MQTT set local address by variables test step</div></div><div class=CToolTip id="tt138"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setRemoteAddress_byVars := 3</td></tr></table></blockquote>Integer constant for the MQTT set remote address by variables test step</div></div><div class=CToolTip id="tt139"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setRemoteAddress_byVars := "MQTT Applib: setRemoteAddress_byVars"</td></tr></table></blockquote>Integer constant for the MQTT set remote address by variables test step</div></div><div class=CToolTip id="tt140"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_startListening := 6</td></tr></table></blockquote>Integer constant for the MQTT start listening test step</div></div><div class=CToolTip id="tt141"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_startListening := "MQTT Applib: startListening"</td></tr></table></blockquote>Charstring constant for the MQTT start listening test step</div></div><div class=CToolTip id="tt142"><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="tt143"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_transportConnect := 4</td></tr></table></blockquote>Integer constant for the MQTT transport connect test step</div></div><div class=CToolTip id="tt144"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_transportConnect := "MQTT Applib: transportConnect"</td></tr></table></blockquote>Charstring constant for the MQTT transport connect test step</div></div><div class=CToolTip id="tt145"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_eventIdx_transportSucc := 0</td></tr></table></blockquote>Integer constant for the MQTT transport succesful indication</div></div><div class=CToolTip id="tt146"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_eventIdx_transportFail := 1</td></tr></table></blockquote>Integer constant for the MQTT transport fail indication</div></div><div class=CToolTip id="tt147"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_transportClose := 5</td></tr></table></blockquote>Integer constant for the MQTT transport close test step</div></div><div class=CToolTip id="tt148"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_transportClose := "MQTT Applib: transportClose"</td></tr></table></blockquote>Charstring constant for the MQTT transport close test step</div></div><div class=CToolTip id="tt149"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_loadTemplate_byIntIdx := 7</td></tr></table></blockquote>Integer constant for the MQTT load template by integer idx pointer test step</div></div><div class=CToolTip id="tt150"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_loadTemplate_byIntIdx := "MQTT Applib: loadTemplate_byIntIdx"</td></tr></table></blockquote>Charstring constant for the MQTT load template by integer idx pointer test step</div></div><div class=CToolTip id="tt151"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_loadTemplate_byStringId := 8</td></tr></table></blockquote>Integer constant for the MQTT load template by string id test step</div></div><div class=CToolTip id="tt152"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_loadTemplate_byStringId := "MQTT Applib: loadTemplate_byStringId"</td></tr></table></blockquote>Charstring constant for the MQTT load template by string id test step</div></div><div class=CToolTip id="tt153"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setTopic_stringParam := 10</td></tr></table></blockquote>Integer constant for the MQTT set topic by string parameter test step</div></div><div class=CToolTip id="tt154"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setTopic_stringParam := "MQTT Applib: setTopic_stringParam"</td></tr></table></blockquote>Charstring constant for the MQTT set topic by string parameter test step</div></div><div class=CToolTip id="tt155"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setTopic_add_stringParam := 11</td></tr></table></blockquote>Integer constant for the MQTT set topic by adding a string test step</div></div><div class=CToolTip id="tt156"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setTopic_add_stringParam := "MQTT Applib: setTopic_add_stringParam"</td></tr></table></blockquote>Charstring constant for the MQTT set topic by adding a string test step</div></div><div class=CToolTip id="tt157"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setTopic_add_varParams := 12</td></tr></table></blockquote>Integer constant for the MQTT set topic by adding variable parameters test step</div></div><div class=CToolTip id="tt158"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setTopic_add_varParams := "MQTT Applib: setTopic_add_varParams"</td></tr></table></blockquote>Charstring constant for the MQTT set topic by adding variable parameters test step</div></div><div class=CToolTip id="tt159"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setTopic_add_clientId := 13</td></tr></table></blockquote>Integer constant for the MQTT set topic by adding the client id test step</div></div><div class=CToolTip id="tt160"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setTopic_add_clientId := "MQTT Applib: setTopic_add_clientId"</td></tr></table></blockquote>Charstring constant for the MQTT set topic by adding the client id test step</div></div><div class=CToolTip id="tt161"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setQos_intParam := 14</td></tr></table></blockquote>Integer constant for the MQTT set QoS using integer parameter test step</div></div><div class=CToolTip id="tt162"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setQos_intParam := "MQTT Applib: setQos_intParam"</td></tr></table></blockquote>Charstring constant for the MQTT set QoS using integer parameter test step</div></div><div class=CToolTip id="tt163"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setPublishMessage_stringParam := 15</td></tr></table></blockquote>Integer constant for the MQTT set publish message using a string parameter test step</div></div><div class=CToolTip id="tt164"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setPublishMessage_stringParam := "MQTT Applib: setPublishMessage_stringParam"</td></tr></table></blockquote>Charstring constant for the MQTT set publish message using a string parameter test step</div></div><div class=CToolTip id="tt165"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setPublishMessage_add_stringParam := 16</td></tr></table></blockquote>Integer constant for the MQTT set publish by adding a string parameter test step</div></div><div class=CToolTip id="tt166"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setPublishMessage_add_stringParam := "MQTT Applib: setPublishMessage_add_stringParam"</td></tr></table></blockquote>Charstring constant for the MQTT set publish by adding a string parameter test step</div></div><div class=CToolTip id="tt167"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setPublishMessage_add_varParams := 17</td></tr></table></blockquote>Integer constant for the MQTT set publish by adding variable parameters test step</div></div><div class=CToolTip id="tt168"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setPublishMessage_add_varParams := "MQTT Applib: setPublishMessage_add_varParams"</td></tr></table></blockquote>Charstring constant for the MQTT set publish by adding variable parameters test step</div></div><div class=CToolTip id="tt169"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_setPublishMessage_add_clientId := 18</td></tr></table></blockquote>Integer constant for the MQTT set publish by adding the client id test step</div></div><div class=CToolTip id="tt170"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_setPublishMessage_add_clientId := "MQTT Applib: setPublishMessage_add_clientId"</td></tr></table></blockquote>Charstring constant for the MQTT set publish by adding the client id test step</div></div><div class=CToolTip id="tt171"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_reportPingResponse := 19</td></tr></table></blockquote>Integer constant for the MQTT enabling/disabling the reporting of a ping response test step</div></div><div class=CToolTip id="tt172"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_reportPingResponse := "MQTT Applib: reportPingResponse"</td></tr></table></blockquote>Charstring constant for the MQTT enabling/disabling the reporting of a ping response test step</div></div><div class=CToolTip id="tt173"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_reportPublishResponse := 20</td></tr></table></blockquote>Integer constant for the MQTT enabling/disabling the reporting of a publish response test step</div></div><div class=CToolTip id="tt174"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_reportPublishResponse := "MQTT Applib: reportPublishResponse"</td></tr></table></blockquote>Charstring constant for the MQTT enabling/disabling the reporting of a publish response test step</div></div><div class=CToolTip id="tt175"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const integer c_MQTT_stepIdx_send := 9</td></tr></table></blockquote>Integer constant for the MQTT send test step</div></div><div class=CToolTip id="tt176"><div class=CConstant><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">const charstring c_MQTT_stepName_send := "MQTT Applib: send"</td></tr></table></blockquote>Charstring constant for the MQTT send test step</div></div><div class=CToolTip id="tt177"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record MQTT_Address_DB</td></tr></table></blockquote>Storing Socket instances</div></div><div class=CToolTip id="tt178"><div class=CType>States of an MQTT_Session state machine</div></div><div class=CToolTip id="tt179"><div class=CType>States of an MQTT_Subscription state machine</div></div><div class=CToolTip id="tt180"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type union MQTT_Publish_State</td></tr></table></blockquote>State of an MQTT_Publish</div></div><!--END_ND_TOOLTIPS--> |
| |
| <script language=JavaScript><!-- |
| if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |
