Skip to content

Commit

Permalink
deploy: 29c8595
Browse files Browse the repository at this point in the history
  • Loading branch information
@mayuki
mayuki committed Jul 12, 2024
1 parent 51de39e commit cfa419b
Show file tree
Hide file tree
Showing 6 changed files with 574 additions and 3 deletions.
305 changes: 305 additions & 0 deletions api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,305 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>IMagicOnionHeartbeatFeature Interface
| MagicOnion </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="IMagicOnionHeartbeatFeature Interface
| MagicOnion ">
<meta name="generator" content="docfx 2.59.2.0">

<link rel="shortcut icon" href="../img/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/cysharp.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">



</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-default ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<div class="navbar-brand">
<a href="../">
<img id="logo" src="../img/Icon.png" alt="">
<span>MagicOnion</span>
</a>
</div>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature">

<h1 id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature" class="text-break">IMagicOnionHeartbeatFeature Interface
</h1>
<h6><strong>Namespace</strong>: <a class="xref" href="MagicOnion.Server.Features.html">MagicOnion.Server.Features</a></h6>
<h6><strong>Assembly</strong>: MagicOnion.Server.dll</h6>

<div class="markdown level0 summary"><p>Provides StreamingHub Heartbeat features.</p>
</div>
<div class="markdown level0 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IMagicOnionHeartbeatFeature</code></pre>
</div>








<h3 id="members">Members</h3>
<h4>Properties
</h4>
<table class="table table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_LastReceivedAt">LastReceivedAt</a>
</td>
<td class="markdown level1 summary"><p>Gets the last received time.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Latency">Latency</a>
</td>
<td class="markdown level1 summary"><p>Gets the latency between client and server. Returns <see cref="!:TimeSpan.Zero"></see> if not sent or received.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_TimeoutToken">TimeoutToken</a>
</td>
<td class="markdown level1 summary"><p>Gets the token to notify a time-out.</p>
</td>
</tr>
</tbody>
</table>
<h4>Methods
</h4>
<table class="table table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Unregister">Unregister()</a>
</td>
<td class="markdown level1 summary"><p>Unregister the current StreamingHub connection from the HeartbeatManager.</p>
</td>
</tr>
</tbody>
</table>

<h3 id="properties">Properties
</h3>
<section>
<a id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_LastReceivedAt_" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt*"></a>
<h4 id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_LastReceivedAt" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt">LastReceivedAt</h4>
<div class="markdown level1 summary"><p>Gets the last received time.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">DateTimeOffset LastReceivedAt { get; }</code></pre>
</div>





<section>
<h5 class="propertyValue">Property Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">DateTimeOffset</span></dt>
<dd></dd>
</dl>
</section>








</section>
<section>
<a id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Latency_" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency*"></a>
<h4 id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Latency" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency">Latency</h4>
<div class="markdown level1 summary"><p>Gets the latency between client and server. Returns <see cref="!:TimeSpan.Zero"></see> if not sent or received.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">TimeSpan Latency { get; }</code></pre>
</div>





<section>
<h5 class="propertyValue">Property Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">TimeSpan</span></dt>
<dd></dd>
</dl>
</section>








</section>
<section>
<a id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_TimeoutToken_" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken*"></a>
<h4 id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_TimeoutToken" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken">TimeoutToken</h4>
<div class="markdown level1 summary"><p>Gets the token to notify a time-out.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">CancellationToken TimeoutToken { get; }</code></pre>
</div>





<section>
<h5 class="propertyValue">Property Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>








</section>
<h3 id="methods">Methods
</h3>
<section>
<a id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Unregister_" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister*"></a>
<h4 id="MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Unregister" data-uid="MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister">Unregister()</h4>
<div class="markdown level1 summary"><p>Unregister the current StreamingHub connection from the HeartbeatManager.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">void Unregister()</code></pre>
</div>













</section>



</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

Copyright © <a href="https://cysharp.co.jp/">Cysharp</a>, Inc. | <span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/docfx.override.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit cfa419b

Please sign in to comment.