blob: 8983bd41f7aa3456004e7424a76b4d7af31876b6 [file] [log] [blame]
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>EPTF_LwM2M_CoapApplibTransport_Definitions - LwM2M_Applib</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_LwM2M_CoapApplibTransport_Definitions"></a>EPTF_LwM2M_CoapApplibTransport_Definitions</h1><div class=CBody><h4 class=CHeading>Purpose</h4><p>This module contains the definitions for the LWM2M transport layer that uses the COAP applib</p><h4 class=CHeading>Module depends on</h4><ul><li><a href="EPTF_LwM2M_Transport_Definitions-ttcn.html#EPTF_LwM2M_Transport_Definitions" class=LFile id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">EPTF_LwM2M_Transport_Definitions</a></li><li>&lt;EPTF_COAP_LGen_Definitions&gt;</li><li>&lt;EPTF_CLL_Base_Definitions&gt;</li></ul><h4 class=CHeading>Module Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>tsp_EPTF_LwM2M_CoapApplibTransport_debug</td><td class=CDLDescription><a href="#tsp_EPTF_LwM2M_CoapApplibTransport_debug" class=LModuleParameter id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">tsp_EPTF_LwM2M_CoapApplibTransport_debug</a> - <b>boolean</b> - Enable/disable debug logging</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#EPTF_LwM2M_CoapApplibTransport_Definitions" >EPTF_LwM2M_CoapApplibTransport_Definitions</a></td><td class=SDescription>This module contains the definitions for the LWM2M transport layer that uses the COAP applib</td></tr><tr class="SModuleParameter SMarked"><td class=SEntry><a href="#tsp_EPTF_LwM2M_CoapApplibTransport_debug" >tsp_EPTF_LwM2M_CoapApplibTransport_debug</a></td><td class=SDescription>Enabled/disable debug logging</td></tr><tr class="SType"><td class=SEntry><a href="#EPTF_LwM2M_CoapApplibTransport_CT" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">EPTF_LwM2M_CoapApplibTransport_CT</a></td><td class=SDescription>LWM2M local transport component realized with &lt;EPTF_COAP_LGen_CT&gt;</td></tr><tr class="SType SMarked"><td class=SEntry><a href="#EPTF_LwM2M_CoapApplibTransport_Statistics" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">EPTF_LwM2M_CoapApplibTransport_Statistics</a></td><td class=SDescription>Storing counters for transport related statistics</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CModuleParameter"><div class=CTopic><h3 class=CTitle><a name="tsp_EPTF_LwM2M_CoapApplibTransport_debug"></a>tsp_EPTF_LwM2M_CoapApplibTransport_debug</h3><div class=CBody><h4 class=CHeading>Purpose</h4><p>Enabled/disable debug logging</p><h4 class=CHeading>Type</h4><p><b>boolean</b></p><h4 class=CHeading>Default value</h4><p><b>false</b></p></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_LwM2M_CoapApplibTransport_CT"></a>EPTF_LwM2M_CoapApplibTransport_CT</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>LWM2M local transport component realized with &lt;EPTF_COAP_LGen_CT&gt;</p><h4 class=CHeading>Class</h4><p>(see EPTF_LwM2M_CoapApplibTransport_Definitions.EPTF_LwM2M_CoapApplibTransport_CT.jpg)</p><h4 class=CHeading>Extensions</h4><ul><li><a href="EPTF_LwM2M_Transport_Definitions-ttcn.html#EPTF_LwM2M_Transport_Provider_CT" class=LType id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">EPTF_LwM2M_Transport_Provider_CT</a></li><li>&lt;EPTF_COAP_LGen_CT&gt;</li><li>&lt;EPTF_Base_CT&gt;</li></ul><h4 class=CHeading>Ports</h4><p>-</p><h4 class=CHeading>Timers</h4><p>-</p><h4 class=CHeading>Variables</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>v_EPTF_LwM2M_CoapApplibTransport_initialized</td><td class=CDLDescription><b>boolean</b> - Flag to indicate if the init function was already called</td></tr></table><h4 class=CHeading>Related Functions</h4><ul><li><a href="EPTF_LwM2M_CoapApplibTransport_Functions-ttcn.html#f_EPTF_LwM2M_CoapApplibTransport_init" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">f_EPTF_LwM2M_CoapApplibTransport_init</a> (<b>in charstring</b> pl_name)</li><li><a href="EPTF_LwM2M_CoapApplibTransport_Functions-ttcn.html#f_EPTF_LwM2M_CoapApplibTransport_cleanup" class=LFunction id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">f_EPTF_LwM2M_CoapApplibTransport_cleanup</a> ()</li><li><a href="EPTF_LwM2M_CoapApplibTransport_Functions-ttcn.html#f_EPTF_LwM2M_CoapApplibTransport_send" class=LFunction id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">f_EPTF_LwM2M_CoapApplibTransport_send</a> (<b>in</b> <a href="EPTF_LwM2M_Transport_Definitions-ttcn.html#EPTF_LwM2M_PDU" class=LType id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">EPTF_LwM2M_PDU</a> pl_msg)</li><li><a href="EPTF_LwM2M_CoapApplibTransport_Functions-ttcn.html#f_EPTF_LwM2M_CoapApplibTransport_messageReceived" class=LFunction id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">f_EPTF_LwM2M_CoapApplibTransport_messageReceived</a> (<b>in</b> &lt;EPTF_COAP_PDU&gt; pl_message, in <b>boolean</b> p_duplicate)</li><li><a href="EPTF_LwM2M_CoapApplibTransport_Functions-ttcn.html#f_EPTF_LwM2M_CoapApplibTransport_eventIndication" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">f_EPTF_LwM2M_CoapApplibTransport_eventIndication</a> (<b>in</b> &lt;EPTF_COAP_EventDescriptor&gt; pl_event)</li><li><a href="EPTF_LwM2M_CoapApplibTransport_Functions-ttcn.html#f_EPTF_LwM2M_CoapApplibTransport_ObjectPath_to_resourceIdString" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">f_EPTF_LwM2M_CoapApplibTransport_ObjectPath_to_resourceIdString</a> (<b>in</b> <a href="LightweightM2M_Types-ttcn.html#ObjectPath" class=LType id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">ObjectPath</a> p_path)</li></ul></div></div></div>
<div class="CType"><div class=CTopic><h3 class=CTitle><a name="EPTF_LwM2M_CoapApplibTransport_Statistics"></a>EPTF_LwM2M_CoapApplibTransport_Statistics</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_LwM2M_CoapApplibTransport_Statistics</td></tr></table></blockquote><h4 class=CHeading>Purpose</h4><p>Storing counters for transport related statistics</p><h4 class=CHeading>Class</h4><p>(see EPTF_LwM2M_CoapApplibTransport_Definitions.EPTF_LwM2M_CoapApplibTransport_Statistics.jpg)</p><h4 class=CHeading>Elements</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>nofReceivedMessages</td><td class=CDLDescription><b>integer</b> - number of received messages</td></tr><tr><td class=CDLEntry>nofSentMessages</td><td class=CDLDescription><b>integer</b> - number of sent messages</td></tr><tr><td class=CDLEntry>nofDecodingErrors</td><td class=CDLDescription><b>integer</b> - number of times the COAP messages couldn&rsquo;t be mapped to LwM2M</td></tr></table></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></blockquote>LWM2M local transport component realized with EPTF_COAP_LGen_CT</div></div><div class=CToolTip id="tt2"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_LwM2M_CoapApplibTransport_Statistics</td></tr></table></blockquote>Storing counters for transport related statistics</div></div><div class=CToolTip id="tt3"><div class=CFile>This module contains the generic transport definitions of the LwM2M load generator</div></div><div class=CToolTip id="tt4"><div class=CModuleParameter>Enabled/disable debug logging</div></div><div class=CToolTip id="tt5"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type component EPTF_LwM2M_Transport_Provider_CT</td></tr></table></blockquote>Base component type for a LwM2M transport realization</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_LwM2M_CoapApplibTransport_init(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>charstring&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>pl_name</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></td></tr></table></blockquote>The main initialization function of the EPTF_LwM2M_CoapApplibTransport_CT component type</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function f_EPTF_LwM2M_CoapApplibTransport_cleanup() runs on EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></blockquote>The main clean up function for the EPTF_LwM2M_CoapApplibTransport_CT component type</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_LwM2M_CoapApplibTransport_send(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>EPTF_LwM2M_PDU&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>pl_msg</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></td></tr></table></blockquote>Function to send out a EPTF_LwM2M_PDU message using the local transport. </div></div><div class=CToolTip id="tt9"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record EPTF_LwM2M_PDU</td></tr></table></blockquote>Encapsulates a LWM2M_PDU with the corresponding entity (and FSM) indices</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_LwM2M_CoapApplibTransport_messageReceived(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>EPTF_COAP_PDU&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>pl_message,</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>boolean&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>p_duplicate,</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>boolean&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>p_autoHandled</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></td></tr></table></blockquote>Handler function to be regsitered into the COAP applib used as transport layer to receive EPTF_COAP_PDU EPTF_COAP_LGen_CT component has a variable <b>vf_COAP_msgReceived</b> with type fcb_EPTF_COAP_messageReceived where this function can be registered in. </div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_LwM2M_CoapApplibTransport_eventIndication(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>EPTF_COAP_EventDescriptor&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>pl_event</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) runs on EPTF_LwM2M_CoapApplibTransport_CT</td></tr></table></td></tr></table></blockquote>Handler function to be registered into the COAP applib used as transport layer to receive EPTF_COAP_EventDescriptor EPTF_COAP_LGen_CT component has a variable <b>vf_COAP_eventIndication</b> with type fcb_EPTF_COAP_eventIndication where this function can be registered in. </div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=4>function f_EPTF_LwM2M_CoapApplibTransport_ObjectPath_to_resourceIdString(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PTypePrefix prettyprint " nowrap>in&nbsp;</td><td class="PType prettyprint " nowrap>ObjectPath&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>p_path</td></tr><tr><td class="PAfterParameters prettyprint "colspan=4>) return charstring</td></tr></table></td></tr></table></blockquote>This function translates an ObjectPath to its charstring representation</div></div><div class=CToolTip id="tt13"><div class=CType><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">type record ObjectPath</td></tr></table></blockquote>Models an access path up to a resource</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>