Skip to content

Commit

Permalink
1.1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@Supereg
Supereg committed May 21, 2022
1 parent 89b04bf commit 657dfcc
Show file tree
Hide file tree
Showing 11 changed files with 42 additions and 42 deletions.
22 changes: 11 additions & 11 deletions docs/classes/ciaoservice.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/responder.html
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Responder | @homebridge/ciao - v1.1.3</title><meta name="description" content="Documentation for @homebridge/ciao - v1.1.3"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@homebridge/ciao - v1.1.3</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@homebridge/ciao - v1.1.3</a></li><li><a href="Responder.html">Responder</a></li></ul><h1>Class Responder</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Responder | @homebridge/ciao - v1.1.5</title><meta name="description" content="Documentation for @homebridge/ciao - v1.1.5"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@homebridge/ciao - v1.1.5</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@homebridge/ciao - v1.1.5</a></li><li><a href="Responder.html">Responder</a></li></ul><h1>Class Responder</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>A Responder instance represents a running MDNSServer and a set of advertised services.</p>
</div><div><p>It will handle any service related operations, like advertising, sending goodbye packets or sending record updates.
It handles answering questions arriving on the multicast address.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Responder</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">PacketHandler</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Responder.html#createService" class="tsd-kind-icon">create<wbr/>Service</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Responder.html#getAnnouncedServices" class="tsd-kind-icon">get<wbr/>Announced<wbr/>Services</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Responder.html#shutdown" class="tsd-kind-icon">shutdown</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createService" class="tsd-anchor"></a><h3>create<wbr/>Service</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Service<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServiceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServiceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/8531ad8/src/Responder.ts#L173">Responder.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Responder</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">PacketHandler</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Responder.html#createService" class="tsd-kind-icon">create<wbr/>Service</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Responder.html#getAnnouncedServices" class="tsd-kind-icon">get<wbr/>Announced<wbr/>Services</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Responder.html#shutdown" class="tsd-kind-icon">shutdown</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createService" class="tsd-anchor"></a><h3>create<wbr/>Service</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Service<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServiceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServiceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/89b04bf/src/Responder.ts#L173">Responder.ts:173</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a new CiaoService instance and links it to this Responder instance.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/ServiceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServiceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Defines all information about the service which should be created.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a></h4><div><p>The newly created <a href="CiaoService.html">CiaoService</a> instance can be used to advertise and manage the created service.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAnnouncedServices" class="tsd-anchor"></a><h3>get<wbr/>Announced<wbr/>Services</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Announced<wbr/>Services<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/8531ad8/src/Responder.ts#L228">Responder.ts:228</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="shutdown" class="tsd-anchor"></a><h3>shutdown</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">shutdown<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/8531ad8/src/Responder.ts#L196">Responder.ts:196</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAnnouncedServices" class="tsd-anchor"></a><h3>get<wbr/>Announced<wbr/>Services</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Announced<wbr/>Services<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/89b04bf/src/Responder.ts#L228">Responder.ts:228</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="CiaoService.html" class="tsd-signature-type" data-tsd-kind="Class">CiaoService</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="shutdown" class="tsd-anchor"></a><h3>shutdown</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">shutdown<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge/ciao/blob/89b04bf/src/Responder.ts#L196">Responder.ts:196</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This method should be called when you want to unpublish all service exposed by this Responder.
This method SHOULD be called before the node application exists, so any host on the
network is informed of the shutdown of this machine.
Expand Down
Loading

0 comments on commit 657dfcc

Please sign in to comment.