| <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>IOT_App_Functions - IoT_Load_Test_Framework</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="IOT_App_Functions"></a>IOT_App_Functions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the functions of RIoT’s main component</p><h4 class=CHeading>See also</h4><p><a href="IOT_App_Definitions-ttcn.html#IOT_App_Definitions" class=LFile id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">IOT_App_Definitions</a></p><h4 class=CHeading>Module depends on</h4><ul><li><a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_Definitions" class=LFile id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">IOT_LGen_Definitions</a></li><li><a href="IOT_LGen_Functions-ttcn.html#IOT_LGen_Functions" class=LFile id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">IOT_LGen_Functions</a></li><li><EPTF_CLL_Base_Functions></li><li><EPTF_CLL_ExecCtrl_Definitions></li><li><EPTF_CLL_ExecCtrl_Functions></li><li><EPTF_CLL_DsRestAPI_Functions></li><li><EPTF_CLL_DataSource_Definitions></li><li><EPTF_CLL_DataSource_Functions></li></ul><h4 class=CHeading>Module Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>tsp_nrOfLGens</td><td class=CDLDescription><tsp_nrOfLGens> - <b>integer</b> - the number of <a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link8 onMouseOver="ShowTip(event, 'tt2', 'link8')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a> instances to be createed during start up</td></tr><tr><td class=CDLEntry>tsp_LGname_prefix</td><td class=CDLDescription><tsp_LGname_prefix> - <b>charstring</b> - name prefix used for the created <a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link9 onMouseOver="ShowTip(event, 'tt2', 'link9')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a> instances</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#IOT_App_Functions" >IOT_App_Functions</a></td><td class=SDescription>This module contains the functions of RIoT’s main component</td></tr><tr class="STestcase SMarked"><td class=SEntry><a href="#TC" >TC</a></td><td class=SDescription>The main entry point of the RIoT application</td></tr><tr class="SFunction"><td class=SEntry><a href="#f_IOT_App_startExecCtrl" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">f_IOT_App_startExecCtrl</a></td><td class=SDescription>Starting up the Execution Control component that will orchestrate the load generator <a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a>,<EPTF_ExecCtrlClient_CT> component instances</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#f_IOT_LGen_create" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">f_IOT_LGen_create</a></td><td class=SDescription>Starting up a load generator <a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link4 onMouseOver="ShowTip(event, 'tt2', 'link4')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a> component instances</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> |
| |
| <div class="CTestcase"><div class=CTopic><h3 class=CTitle><a name="TC"></a>TC</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>The main entry point of the RIoT application</p><h4 class=CHeading>Related Types</h4><p><a href="IOT_App_Definitions-ttcn.html#IOT_App_CT" class=LType id=link10 onMouseOver="ShowTip(event, 'tt7', 'link10')" onMouseOut="HideTip('tt7')">IOT_App_CT</a></p></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_IOT_App_startExecCtrl"></a>f_IOT_App_startExecCtrl</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_IOT_App_startExecCtrl(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_selfName,</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_nrOfClients,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_DataSource_CT </td><td class="PParameter prettyprint " nowrap width=100%>pl_datasource</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_ExecCtrl_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Starting up the Execution Control component that will orchestrate the load generator <a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link11 onMouseOver="ShowTip(event, 'tt2', 'link11')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a>,<EPTF_ExecCtrlClient_CT> component instances</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_selfName</td><td class=CDLDescription><b>in charstring</b> - name of the execution control components instance</td></tr><tr><td class=CDLEntry>pl_nrOfClients</td><td class=CDLDescription><b>in integer</b> - number of <EPTF_ExecCtrlClient_CT> load generator components to wait for</td></tr><tr><td class=CDLEntry>pl_datasource</td><td class=CDLDescription><b>in</b> <EPTF_DataSource_CT> - data source server</td></tr></table><h4 class=CHeading>Related Types</h4><p><EPTF_ExecCtrl_CT></p><h4 class=CHeading>Related functions</h4><ul><li><f_EPTF_ExecCtrl_loadConfig></li><li><f_EPTF_ExecCtrl_init_CT></li></ul></div></div></div> |
| |
| <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="f_IOT_LGen_create"></a>f_IOT_LGen_create</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_IOT_LGen_create (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_hostname,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_componentName</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_ExecCtrl_CT return EPTF_ExecCtrlClient_CT</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Starting up a load generator <a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link12 onMouseOver="ShowTip(event, 'tt2', 'link12')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a> component instances</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pl_hostname</td><td class=CDLDescription><b>in charstring</b> - name of the host, where the load generator instance will be created</td></tr><tr><td class=CDLEntry>pl_componentName</td><td class=CDLDescription><b>in charstring</b> - the name of the load generator component instance</td></tr></table><h4 class=CHeading>Related Types</h4><p><a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link13 onMouseOver="ShowTip(event, 'tt2', 'link13')" onMouseOut="HideTip('tt2')">IOT_LGen_CT</a> <EPTF_ExecCtrlClient_CT> <EPTF_ExecCtrl_CT></p><h4 class=CHeading>Related functions</h4><ul><li><a href="InfluxDB_Functions-ttcn.html#f_IOT_LGen_behavior" class=LFunction id=link14 onMouseOver="ShowTip(event, 'tt8', 'link14')" onMouseOut="HideTip('tt8')">f_IOT_LGen_behavior</a></li></ul></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 "colspan=4>function f_IOT_App_startExecCtrl(</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_selfName,</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_nrOfClients,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>EPTF_DataSource_CT </td><td class="PParameter prettyprint " nowrap width=100%>pl_datasource</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_ExecCtrl_CT</td></tr></table></td></tr></table></blockquote>Starting up the Execution Control component that will orchestrate the load generator IOT_LGen_CT,<EPTF_ExecCtrlClient_CT> component instances</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 IOT_LGen_CT</td></tr></table></blockquote>IoT 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><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_IOT_LGen_create (</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_hostname,</td></tr><tr><td> </td><td class="PTypePrefix prettyprint " nowrap>in </td><td class="PType prettyprint " nowrap>charstring </td><td class="PParameter prettyprint " nowrap width=100%>pl_componentName</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_ExecCtrl_CT return EPTF_ExecCtrlClient_CT</td></tr></table></td></tr></table></blockquote>Starting up a load generator IOT_LGen_CT component instances</div></div><div class=CToolTip id="tt4"><div class=CFile>This module contains the definitions for RIoT’s main component</div></div><div class=CToolTip id="tt5"><div class=CFile>This module contains the definitions for an IoT load generator component</div></div><div class=CToolTip id="tt6"><div class=CFile>This module contains the functions of an IoT load generator component</div></div><div class=CToolTip id="tt7"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component IOT_App_CT extends EPTF_Base_CT, EPTF_DsRestAPI_CT</td></tr></table></blockquote>RIoT application’s main component providing a REST API to the environment</div></div><div class=CToolTip id="tt8"><div class=CFunction>The main initialization function for the InfluxDB_CT component type</div></div><!--END_ND_TOOLTIPS--> |
| |
| <script language=JavaScript><!-- |
| if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |
