tcp-serial-relay
Version:
Modular TCP to Serial relay service with comprehensive logging, monitoring and web dashboard
790 lines (117 loc) • 6.78 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TcpSerialRelayApp</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: TcpSerialRelayApp</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>TcpSerialRelayApp<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Main application class</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="TcpSerialRelayApp"><span class="type-signature"></span>new TcpSerialRelayApp<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getHealthStatus"><span class="type-signature"></span>getHealthStatus<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get application health status
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line172">line 172</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initializeRelayService"><span class="type-signature">(async) </span>initializeRelayService<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Initialize the relay service
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="loadConfiguration"><span class="type-signature">(async) </span>loadConfiguration<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Load and validate configuration
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<h4 class="name" id="run"><span class="type-signature">(async) </span>run<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Initialize and run the application
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setupRelayEventHandlers"><span class="type-signature"></span>setupRelayEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Setup event handlers for the relay service
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setupShutdownHandler"><span class="type-signature"></span>setupShutdownHandler<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Setup shutdown handler for the relay service
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line140">line 140</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startRelayService"><span class="type-signature">(async) </span>startRelayService<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Start the relay service
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app.js.html">app.js</a>, <a href="app.js.html#line157">line 157</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="TcpSerialRelayApp.html">TcpSerialRelayApp</a></li></ul><h3>Global</h3><ul><li><a href="global.html#main">main</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri May 23 2025 21:15:04 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>