| <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>IOT_App_Definitions - 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_Definitions"></a>IOT_App_Definitions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the definitions for RIoT’s main component</p><h4 class=CHeading>Detailed comments</h4><p>RIoT is a load generator built on top of the TitanSim load generator framework. It is capable of simulating devices using some IoT protocols (CoAP, LwM2M, MQTT, HTTP). RIoT (and the TitanSim framework) was created to support non-functional tests, where load generation is required like performance, stability, scalability.</p><h4 class=CHeading>Module depends on</h4><ul><li><EPTF_CLL_Base_Definitions></li><li><EPTF_CLL_DsRestAPI_Definitions></li></ul><h4 class=CHeading>Module Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress</td><td class=CDLDescription><a href="#tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress" class=LModuleParameter id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress</a> - <b>charstring</b> - the IP address of the REST API server</td></tr><tr><td class=CDLEntry>tsp_EPTF_DsRestAPI_HTTPServer_RemotePort</td><td class=CDLDescription><a href="#tsp_EPTF_DsRestAPI_HTTPServer_RemotePort" class=LModuleParameter id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">tsp_EPTF_DsRestAPI_HTTPServer_RemotePort</a> - <b>charstring</b> - the port number of the REST API server</td></tr><tr><td class=CDLEntry>tsp_EPTF_DsRestAPI_HTTPServer_directory</td><td class=CDLDescription><a href="#tsp_EPTF_DsRestAPI_HTTPServer_directory" class=LModuleParameter id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">tsp_EPTF_DsRestAPI_HTTPServer_directory</a> - <b>charstring</b> - the path of REST API HTTP server directory</td></tr><tr><td class=CDLEntry>tsp_EPTF_DsRestAPI_customizableApp_directory</td><td class=CDLDescription><a href="#tsp_EPTF_DsRestAPI_customizableApp_directory" class=LModuleParameter id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">tsp_EPTF_DsRestAPI_customizableApp_directory</a> - <b>charstring</b> - the path of the REST API customizableApp directory</td></tr><tr><td class=CDLEntry>tsp_EPTF_DsRestAPI_API_directory</td><td class=CDLDescription><a href="#tsp_EPTF_DsRestAPI_API_directory" class=LModuleParameter id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">tsp_EPTF_DsRestAPI_API_directory</a> - <b>charstring</b> - the path of DsRestAPI API directory</td></tr></table><h4 class=CHeading>Configuration</h4><ul><li><tsp_EPTF_ExecCtrl_LGenPool_Declarators></li><li><tsp_EPTF_ExecCtrl_EntityGroup2LGenPool_List></li><li><tsp_LGenBase_EntityGrpDeclarators></li><li><tsp_EPTF_ExecCtrl_Scenario2EntityGroupList></li><li><tsp_LGenBase_TcMgmt_ScenarioDeclarators3></li><li><tsp_LGenBase_TcMgmt_tcTypeDeclarators2></li><li><a href="IOT_LGen_Definitions-ttcn.html#tsp_IOT_LGen_FSMs" class=LModuleParameter id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">tsp_IOT_LGen_FSMs</a></li></ul><h4 class=CHeading>Component Diagram</h4><p>(see IOT_App_Definitions.components.jpg)</p><h4 class=CHeading>Related Types</h4><ul><li><a href="#IOT_App_CT" class=LType id=link8 onMouseOver="ShowTip(event, 'tt1', 'link8')" onMouseOut="HideTip('tt1')">IOT_App_CT</a></li><li><a href="IOT_LGen_Definitions-ttcn.html#IOT_LGen_CT" class=LType id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">IOT_LGen_CT</a></li><li><EPTF_ExecCtrl_CT></li></ul><!--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_Definitions" >IOT_App_Definitions</a></td><td class=SDescription>This module contains the definitions for RIoT’s main component</td></tr><tr class="SModuleParameter SMarked"><td class=SEntry><a href="#tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress" >tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress</a></td><td class=SDescription>IP address of the REST API server</td></tr><tr class="SModuleParameter"><td class=SEntry><a href="#tsp_EPTF_DsRestAPI_HTTPServer_RemotePort" >tsp_EPTF_DsRestAPI_HTTPServer_RemotePort</a></td><td class=SDescription>Port number of the REST API server</td></tr><tr class="SModuleParameter SMarked"><td class=SEntry><a href="#tsp_EPTF_DsRestAPI_HTTPServer_directory" >tsp_EPTF_DsRestAPI_HTTPServer_directory</a></td><td class=SDescription>Path of REST API HTTP server directory</td></tr><tr class="SModuleParameter"><td class=SEntry><a href="#tsp_EPTF_DsRestAPI_customizableApp_directory" >tsp_EPTF_DsRestAPI_customizableApp_directory</a></td><td class=SDescription>Path of the REST API customizableApp directory</td></tr><tr class="SModuleParameter SMarked"><td class=SEntry><a href="#tsp_EPTF_DsRestAPI_API_directory" >tsp_EPTF_DsRestAPI_API_directory</a></td><td class=SDescription>Path of DsRestAPI API directory</td></tr><tr class="SType"><td class=SEntry><a href="#IOT_App_CT" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">IOT_App_CT</a></td><td class=SDescription>RIoT application’s main component providing a REST API to the environment</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div> |
| |
| <div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress"></a>tsp_EPTF_DsRestAPI_HTTPServer_RemoteAddress</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>IP address of the REST API server</p><h4 class=CHeading>Type</h4><p><b>charstring</b></p><h4 class=CHeading>Default value</h4><p><b>”127.0.0.1”</b></p></div></div></div> |
| |
| <div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_DsRestAPI_HTTPServer_RemotePort"></a>tsp_EPTF_DsRestAPI_HTTPServer_RemotePort</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Port number of the REST API server</p><h4 class=CHeading>Type</h4><p><b>integer</b></p><h4 class=CHeading>Default value</h4><p><b>4040</b></p></div></div></div> |
| |
| <div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_DsRestAPI_HTTPServer_directory"></a>tsp_EPTF_DsRestAPI_HTTPServer_directory</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Path of REST API HTTP server directory</p><h4 class=CHeading>Type</h4><p><b>charstring</b></p><h4 class=CHeading>Default value</h4><p><b>”./WebGUI/WebGUI_link/”</b></p></div></div></div> |
| |
| <div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_DsRestAPI_customizableApp_directory"></a>tsp_EPTF_DsRestAPI_customizableApp_directory</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Path of the REST API customizableApp directory</p><h4 class=CHeading>Type</h4><p><b>charstring</b></p><h4 class=CHeading>Default value</h4><p><b>”./WebGUI/GUICustomization_link”</b></p></div></div></div> |
| |
| <div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_DsRestAPI_API_directory"></a>tsp_EPTF_DsRestAPI_API_directory</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Path of DsRestAPI API directory</p><h4 class=CHeading>Type</h4><p><b>charstring</b></p><h4 class=CHeading>Default value</h4><p><b>”./WebGUI/Js_link”</b></p></div></div></div> |
| |
| <div class="CType"><div class=CTopic><h3 class=CTitle><a name="IOT_App_CT"></a>IOT_App_CT</h3><div class=CBody><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><h4 class=CHeading>Purpose</h4><p>RIoT application’s main component providing a REST API to the environment</p><h4 class=CHeading>Extensions</h4><ul><li><EPTF_Base_CT></li><li><EPTF_DsRestAPI_CT></li></ul><h4 class=CHeading>Related Functions</h4><ul><li><a href="IOT_App_Functions-ttcn.html#TC" class=LTestcase id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">TC</a> () - The main test case function, entry point of the application</li></ul></div></div></div> |
| |
| </div><!--Content--> |
| |
| |
| |
| <!--START_ND_TOOLTIPS--> |
| <div class=CToolTip id="tt1"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td 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="tt2"><div class=CModuleParameter>IP address of the REST API server</div></div><div class=CToolTip id="tt3"><div class=CModuleParameter>Port number of the REST API server</div></div><div class=CToolTip id="tt4"><div class=CModuleParameter>Path of REST API HTTP server directory</div></div><div class=CToolTip id="tt5"><div class=CModuleParameter>Path of the REST API customizableApp directory</div></div><div class=CToolTip id="tt6"><div class=CModuleParameter>Path of DsRestAPI API directory</div></div><div class=CToolTip id="tt7"><div class=CModuleParameter>FSM declarations that can be instantiated for the traffic cases</div></div><div class=CToolTip id="tt8"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component IOT_LGen_CT</td></tr></table></blockquote>IoT load generator component</div></div><div class=CToolTip id="tt9"><div class=CTestcase>The main entry point of the RIoT application</div></div><!--END_ND_TOOLTIPS--> |
| |
| <script language=JavaScript><!-- |
| if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html> |
