Skip to content

Commit

Permalink
deploy: 031788f
Browse files Browse the repository at this point in the history
  • Loading branch information
mayuki committed Jul 5, 2024
1 parent 4c04cc8 commit 51de39e
Show file tree
Hide file tree
Showing 7 changed files with 377 additions and 35 deletions.
3 changes: 2 additions & 1 deletion api/MagicOnion.Client.ClientHeartbeatEvent.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ <h1 id="MagicOnion_Client_ClientHeartbeatEvent" data-uid="MagicOnion.Client.Clie
<h6><strong>Namespace</strong>: <a class="xref" href="MagicOnion.Client.html">MagicOnion.Client</a></h6>
<h6><strong>Assembly</strong>: MagicOnion.Client.dll</h6>

<div class="markdown level0 summary"></div>
<div class="markdown level0 summary"><p>Represents a client heartbeat received event.</p>
</div>
<div class="markdown level0 conceptual"></div>

<div class="codewrapper">
Expand Down
274 changes: 274 additions & 0 deletions api/MagicOnion.Client.ServerHeartbeatEvent.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,274 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>ServerHeartbeatEvent Struct
| MagicOnion </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="ServerHeartbeatEvent Struct
| 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.Client.ServerHeartbeatEvent">

<h1 id="MagicOnion_Client_ServerHeartbeatEvent" data-uid="MagicOnion.Client.ServerHeartbeatEvent" class="text-break">ServerHeartbeatEvent Struct
</h1>
<h6><strong>Namespace</strong>: <a class="xref" href="MagicOnion.Client.html">MagicOnion.Client</a></h6>
<h6><strong>Assembly</strong>: MagicOnion.Client.dll</h6>

<div class="markdown level0 summary"><p>Represents a server heartbeat received event.</p>
</div>
<div class="markdown level0 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly struct ServerHeartbeatEvent</code></pre>
</div>








<h3 id="members">Members</h3>
<h4>Constructors
</h4>
<table class="table table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="MagicOnion.Client.ServerHeartbeatEvent.html#MagicOnion_Client_ServerHeartbeatEvent__ctor_System_Int64_ReadOnlyMemory_System_Byte__">ServerHeartbeatEvent(Int64, ReadOnlyMemory&lt;Byte&gt;)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
</tbody>
</table>
<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.Client.ServerHeartbeatEvent.html#MagicOnion_Client_ServerHeartbeatEvent_Metadata">Metadata</a>
</td>
<td class="markdown level1 summary"><p>Gets the metadata data. The data is only available during event processing.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="MagicOnion.Client.ServerHeartbeatEvent.html#MagicOnion_Client_ServerHeartbeatEvent_ServerTime">ServerTime</a>
</td>
<td class="markdown level1 summary"><p>Gets the server time at when the heartbeat was sent.</p>
</td>
</tr>
</tbody>
</table>

<h3 id="constructors">Constructors
</h3>
<section>
<a id="MagicOnion_Client_ServerHeartbeatEvent__ctor_" data-uid="MagicOnion.Client.ServerHeartbeatEvent.#ctor*"></a>
<h4 id="MagicOnion_Client_ServerHeartbeatEvent__ctor_System_Int64_ReadOnlyMemory_System_Byte__" data-uid="MagicOnion.Client.ServerHeartbeatEvent.#ctor(System.Int64,ReadOnlyMemory{System.Byte})">ServerHeartbeatEvent(Int64, ReadOnlyMemory&lt;Byte&gt;)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerHeartbeatEvent(long serverTimeUnixMs, ReadOnlyMemory&lt;byte&gt; metadata)</code></pre>
</div>

<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>serverTimeUnixMs</code></span> <span class="xref">System.Int64</span></dt>
<dd></dd>
<dt><span class="parametername"><code>metadata</code></span> <span class="xref">ReadOnlyMemory</span>&lt;<span class="xref">System.Byte</span>&gt;</dt>
<dd></dd>
</dl>
</section>












</section>
<h3 id="properties">Properties
</h3>
<section>
<a id="MagicOnion_Client_ServerHeartbeatEvent_Metadata_" data-uid="MagicOnion.Client.ServerHeartbeatEvent.Metadata*"></a>
<h4 id="MagicOnion_Client_ServerHeartbeatEvent_Metadata" data-uid="MagicOnion.Client.ServerHeartbeatEvent.Metadata">Metadata</h4>
<div class="markdown level1 summary"><p>Gets the metadata data. The data is only available during event processing.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly ReadOnlyMemory&lt;byte&gt; Metadata { get; }</code></pre>
</div>





<section>
<h5 class="propertyValue">Property Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">ReadOnlyMemory</span>&lt;<span class="xref">System.Byte</span>&gt;</dt>
<dd></dd>
</dl>
</section>








</section>
<section>
<a id="MagicOnion_Client_ServerHeartbeatEvent_ServerTime_" data-uid="MagicOnion.Client.ServerHeartbeatEvent.ServerTime*"></a>
<h4 id="MagicOnion_Client_ServerHeartbeatEvent_ServerTime" data-uid="MagicOnion.Client.ServerHeartbeatEvent.ServerTime">ServerTime</h4>
<div class="markdown level1 summary"><p>Gets the server time at when the heartbeat was sent.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly DateTimeOffset ServerTime { 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>



</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>
20 changes: 10 additions & 10 deletions api/MagicOnion.Client.StreamingHubClientOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h4>Constructors
</tr>
<tr>
<td>
<a class="xref" href="MagicOnion.Client.StreamingHubClientOptions.html#MagicOnion_Client_StreamingHubClientOptions__ctor_System_Nullable_System_String__CallOptions_MagicOnion_Serialization_IMagicOnionSerializerProvider_MagicOnion_Client_IMagicOnionClientLogger_System_Nullable_TimeSpan__System_Nullable_TimeSpan__System_Nullable_Action_ReadOnlyMemory_System_Byte____System_Nullable_Action_MagicOnion_Client_ClientHeartbeatEvent___">StreamingHubClientOptions(Nullable&lt;String&gt;, CallOptions, IMagicOnionSerializerProvider, IMagicOnionClientLogger, Nullable&lt;TimeSpan&gt;, Nullable&lt;TimeSpan&gt;, Nullable&lt;Action&lt;ReadOnlyMemory&lt;Byte&gt;&gt;&gt;, Nullable&lt;Action&lt;ClientHeartbeatEvent&gt;&gt;)</a>
<a class="xref" href="MagicOnion.Client.StreamingHubClientOptions.html#MagicOnion_Client_StreamingHubClientOptions__ctor_System_Nullable_System_String__CallOptions_MagicOnion_Serialization_IMagicOnionSerializerProvider_MagicOnion_Client_IMagicOnionClientLogger_System_Nullable_TimeSpan__System_Nullable_TimeSpan__System_Nullable_Action_MagicOnion_Client_ServerHeartbeatEvent___System_Nullable_Action_MagicOnion_Client_ClientHeartbeatEvent___">StreamingHubClientOptions(Nullable&lt;String&gt;, CallOptions, IMagicOnionSerializerProvider, IMagicOnionClientLogger, Nullable&lt;TimeSpan&gt;, Nullable&lt;TimeSpan&gt;, Nullable&lt;Action&lt;ServerHeartbeatEvent&gt;&gt;, Nullable&lt;Action&lt;ClientHeartbeatEvent&gt;&gt;)</a>
</td>
<td class="markdown level1 summary"></td>
</tr>
Expand Down Expand Up @@ -245,7 +245,7 @@ <h4>Methods
</tr>
<tr>
<td>
<a class="xref" href="MagicOnion.Client.StreamingHubClientOptions.html#MagicOnion_Client_StreamingHubClientOptions_WithServerHeartbeatReceived_System_Nullable_Action_ReadOnlyMemory_System_Byte____">WithServerHeartbeatReceived(Nullable&lt;Action&lt;ReadOnlyMemory&lt;Byte&gt;&gt;&gt;)</a>
<a class="xref" href="MagicOnion.Client.StreamingHubClientOptions.html#MagicOnion_Client_StreamingHubClientOptions_WithServerHeartbeatReceived_System_Nullable_Action_MagicOnion_Client_ServerHeartbeatEvent___">WithServerHeartbeatReceived(Nullable&lt;Action&lt;ServerHeartbeatEvent&gt;&gt;)</a>
</td>
<td class="markdown level1 summary"><p>Sets a heartbeat callback. If additional metadata is provided by the server in the heartbeat message, this metadata is provided as an argument.</p>
</td>
Expand Down Expand Up @@ -293,12 +293,12 @@ <h5 class="parameters">Parameters</h5>
</section>
<section>
<a id="MagicOnion_Client_StreamingHubClientOptions__ctor_" data-uid="MagicOnion.Client.StreamingHubClientOptions.#ctor*"></a>
<h4 id="MagicOnion_Client_StreamingHubClientOptions__ctor_System_Nullable_System_String__CallOptions_MagicOnion_Serialization_IMagicOnionSerializerProvider_MagicOnion_Client_IMagicOnionClientLogger_System_Nullable_TimeSpan__System_Nullable_TimeSpan__System_Nullable_Action_ReadOnlyMemory_System_Byte____System_Nullable_Action_MagicOnion_Client_ClientHeartbeatEvent___" data-uid="MagicOnion.Client.StreamingHubClientOptions.#ctor(System.Nullable{System.String},CallOptions,MagicOnion.Serialization.IMagicOnionSerializerProvider,MagicOnion.Client.IMagicOnionClientLogger,System.Nullable{TimeSpan},System.Nullable{TimeSpan},System.Nullable{Action{ReadOnlyMemory{System.Byte}}},System.Nullable{Action{MagicOnion.Client.ClientHeartbeatEvent}})">StreamingHubClientOptions(Nullable&lt;String&gt;, CallOptions, IMagicOnionSerializerProvider, IMagicOnionClientLogger, Nullable&lt;TimeSpan&gt;, Nullable&lt;TimeSpan&gt;, Nullable&lt;Action&lt;ReadOnlyMemory&lt;Byte&gt;&gt;&gt;, Nullable&lt;Action&lt;ClientHeartbeatEvent&gt;&gt;)</h4>
<h4 id="MagicOnion_Client_StreamingHubClientOptions__ctor_System_Nullable_System_String__CallOptions_MagicOnion_Serialization_IMagicOnionSerializerProvider_MagicOnion_Client_IMagicOnionClientLogger_System_Nullable_TimeSpan__System_Nullable_TimeSpan__System_Nullable_Action_MagicOnion_Client_ServerHeartbeatEvent___System_Nullable_Action_MagicOnion_Client_ClientHeartbeatEvent___" data-uid="MagicOnion.Client.StreamingHubClientOptions.#ctor(System.Nullable{System.String},CallOptions,MagicOnion.Serialization.IMagicOnionSerializerProvider,MagicOnion.Client.IMagicOnionClientLogger,System.Nullable{TimeSpan},System.Nullable{TimeSpan},System.Nullable{Action{MagicOnion.Client.ServerHeartbeatEvent}},System.Nullable{Action{MagicOnion.Client.ClientHeartbeatEvent}})">StreamingHubClientOptions(Nullable&lt;String&gt;, CallOptions, IMagicOnionSerializerProvider, IMagicOnionClientLogger, Nullable&lt;TimeSpan&gt;, Nullable&lt;TimeSpan&gt;, Nullable&lt;Action&lt;ServerHeartbeatEvent&gt;&gt;, Nullable&lt;Action&lt;ClientHeartbeatEvent&gt;&gt;)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public StreamingHubClientOptions(string? host, CallOptions callOptions, IMagicOnionSerializerProvider serializerProvider, IMagicOnionClientLogger logger, TimeSpan? clientHeartbeatInterval, TimeSpan? clientHeartbeatTimeout, Action&lt;ReadOnlyMemory&lt;byte&gt;&gt;? onServerHeartbeatReceived, Action&lt;ClientHeartbeatEvent&gt;? onClientHeartbeatResponseReceived)</code></pre>
<pre><code class="lang-csharp hljs">public StreamingHubClientOptions(string? host, CallOptions callOptions, IMagicOnionSerializerProvider serializerProvider, IMagicOnionClientLogger logger, TimeSpan? clientHeartbeatInterval, TimeSpan? clientHeartbeatTimeout, Action&lt;ServerHeartbeatEvent&gt;? onServerHeartbeatReceived, Action&lt;ClientHeartbeatEvent&gt;? onClientHeartbeatResponseReceived)</code></pre>
</div>

<section>
Expand All @@ -316,7 +316,7 @@ <h5 class="parameters">Parameters</h5>
<dd></dd>
<dt><span class="parametername"><code>clientHeartbeatTimeout</code></span> <span class="xref">System.Nullable</span>&lt;<span class="xref">TimeSpan</span>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>onServerHeartbeatReceived</code></span> <span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<span class="xref">ReadOnlyMemory</span>&lt;<span class="xref">System.Byte</span>&gt;&gt;&gt;</dt>
<dt><span class="parametername"><code>onServerHeartbeatReceived</code></span> <span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<a class="xref" href="MagicOnion.Client.ServerHeartbeatEvent.html">ServerHeartbeatEvent</a>&gt;&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>onClientHeartbeatResponseReceived</code></span> <span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<a class="xref" href="MagicOnion.Client.ClientHeartbeatEvent.html">ClientHeartbeatEvent</a>&gt;&gt;</dt>
<dd></dd>
Expand Down Expand Up @@ -524,7 +524,7 @@ <h4 id="MagicOnion_Client_StreamingHubClientOptions_OnServerHeartbeatReceived" d
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Action&lt;ReadOnlyMemory&lt;byte&gt;&gt;? OnServerHeartbeatReceived { get; }</code></pre>
<pre><code class="lang-csharp hljs">public Action&lt;ServerHeartbeatEvent&gt;? OnServerHeartbeatReceived { get; }</code></pre>
</div>


Expand All @@ -534,7 +534,7 @@ <h4 id="MagicOnion_Client_StreamingHubClientOptions_OnServerHeartbeatReceived" d
<section>
<h5 class="propertyValue">Property Value</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<span class="xref">ReadOnlyMemory</span>&lt;<span class="xref">System.Byte</span>&gt;&gt;&gt;</dt>
<dt><span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<a class="xref" href="MagicOnion.Client.ServerHeartbeatEvent.html">ServerHeartbeatEvent</a>&gt;&gt;</dt>
<dd></dd>
</dl>
</section>
Expand Down Expand Up @@ -886,19 +886,19 @@ <h5 class="returns">Returns</h5>
</section>
<section>
<a id="MagicOnion_Client_StreamingHubClientOptions_WithServerHeartbeatReceived_" data-uid="MagicOnion.Client.StreamingHubClientOptions.WithServerHeartbeatReceived*"></a>
<h4 id="MagicOnion_Client_StreamingHubClientOptions_WithServerHeartbeatReceived_System_Nullable_Action_ReadOnlyMemory_System_Byte____" data-uid="MagicOnion.Client.StreamingHubClientOptions.WithServerHeartbeatReceived(System.Nullable{Action{ReadOnlyMemory{System.Byte}}})">WithServerHeartbeatReceived(Nullable&lt;Action&lt;ReadOnlyMemory&lt;Byte&gt;&gt;&gt;)</h4>
<h4 id="MagicOnion_Client_StreamingHubClientOptions_WithServerHeartbeatReceived_System_Nullable_Action_MagicOnion_Client_ServerHeartbeatEvent___" data-uid="MagicOnion.Client.StreamingHubClientOptions.WithServerHeartbeatReceived(System.Nullable{Action{MagicOnion.Client.ServerHeartbeatEvent}})">WithServerHeartbeatReceived(Nullable&lt;Action&lt;ServerHeartbeatEvent&gt;&gt;)</h4>
<div class="markdown level1 summary"><p>Sets a heartbeat callback. If additional metadata is provided by the server in the heartbeat message, this metadata is provided as an argument.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public StreamingHubClientOptions WithServerHeartbeatReceived(Action&lt;ReadOnlyMemory&lt;byte&gt;&gt;? onServerHeartbeatReceived)</code></pre>
<pre><code class="lang-csharp hljs">public StreamingHubClientOptions WithServerHeartbeatReceived(Action&lt;ServerHeartbeatEvent&gt;? onServerHeartbeatReceived)</code></pre>
</div>

<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>onServerHeartbeatReceived</code></span> <span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<span class="xref">ReadOnlyMemory</span>&lt;<span class="xref">System.Byte</span>&gt;&gt;&gt;</dt>
<dt><span class="parametername"><code>onServerHeartbeatReceived</code></span> <span class="xref">System.Nullable</span>&lt;<span class="xref">Action</span>&lt;<a class="xref" href="MagicOnion.Client.ServerHeartbeatEvent.html">ServerHeartbeatEvent</a>&gt;&gt;</dt>
<dd></dd>
</dl>
</section>
Expand Down
Loading

0 comments on commit 51de39e

Please sign in to comment.