From cfa419b6da884d5379b7e3a75c22967a8bbd84c3 Mon Sep 17 00:00:00 2001 From: mayuki Date: Fri, 12 Jul 2024 07:37:02 +0000 Subject: [PATCH] deploy: 29c8595c335ec9c7380dea500a8bb6384b7d41d6 --- ....Features.IMagicOnionHeartbeatFeature.html | 305 ++++++++++++++++++ api/MagicOnion.Server.Features.html | 117 +++++++ api/MagicOnion.Server.MagicOnionOptions.html | 38 +++ api/toc.html | 10 + manifest.json | 30 +- xrefmap.yml | 77 +++++ 6 files changed, 574 insertions(+), 3 deletions(-) create mode 100644 api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html create mode 100644 api/MagicOnion.Server.Features.html diff --git a/api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html b/api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html new file mode 100644 index 000000000..574217325 --- /dev/null +++ b/api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html @@ -0,0 +1,305 @@ + + + + + + + IMagicOnionHeartbeatFeature Interface + | MagicOnion + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ +

IMagicOnionHeartbeatFeature Interface +

+
Namespace: MagicOnion.Server.Features
+
Assembly: MagicOnion.Server.dll
+ +

Provides StreamingHub Heartbeat features.

+
+
+ +
+ 
public interface IMagicOnionHeartbeatFeature
+
+ + + + + + + + +

Members

+

Properties +

+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ LastReceivedAt +

Gets the last received time.

+
+ Latency +

Gets the latency between client and server. Returns if not sent or received.

+
+ TimeoutToken +

Gets the token to notify a time-out.

+
+

Methods +

+ + + + + + + + + + + + + +
NameDescription
+ Unregister() +

Unregister the current StreamingHub connection from the HeartbeatManager.

+
+ +

Properties +

+
+ +

LastReceivedAt

+

Gets the last received time.

+
+
+ +
+ 
DateTimeOffset LastReceivedAt { get; }
+
+ + + + + +
+
Property Value
+
+
DateTimeOffset
+
+
+
+ + + + + + + + +
+
+ +

Latency

+

Gets the latency between client and server. Returns if not sent or received.

+
+
+ +
+ 
TimeSpan Latency { get; }
+
+ + + + + +
+
Property Value
+
+
TimeSpan
+
+
+
+ + + + + + + + +
+
+ +

TimeoutToken

+

Gets the token to notify a time-out.

+
+
+ +
+ 
CancellationToken TimeoutToken { get; }
+
+ + + + + +
+
Property Value
+
+
CancellationToken
+
+
+
+ + + + + + + + +
+

Methods +

+
+ +

Unregister()

+

Unregister the current StreamingHub connection from the HeartbeatManager.

+
+
+ +
+ 
void Unregister()
+
+ + + + + + + + + + + + + +
+ + + +
+
+ + +
+
+ + +
+ + + + + + + diff --git a/api/MagicOnion.Server.Features.html b/api/MagicOnion.Server.Features.html new file mode 100644 index 000000000..cb28248db --- /dev/null +++ b/api/MagicOnion.Server.Features.html @@ -0,0 +1,117 @@ + + + + + + + MagicOnion.Server.Features Namespace + | MagicOnion + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ +

MagicOnion.Server.Features Namespace +

+
+
+
+

Interfaces +

+

IMagicOnionHeartbeatFeature

+

Provides StreamingHub Heartbeat features.

+
+
+
+ + +
+
+ + +
+ + + + + + + diff --git a/api/MagicOnion.Server.MagicOnionOptions.html b/api/MagicOnion.Server.MagicOnionOptions.html index 9ab04529c..a19b773fd 100644 --- a/api/MagicOnion.Server.MagicOnionOptions.html +++ b/api/MagicOnion.Server.MagicOnionOptions.html @@ -188,6 +188,13 @@

Properties StreamingHubHeartbeatTimeout

Gets or sets a StreamingHub heartbeat timeout. Default is . If the value is , the server does not disconnect a client due to timeout.

+ + + + + TimeProvider + +

Gets or sets a used internally by MagicOnion.

@@ -499,6 +506,37 @@

Property Value
+ +
+ +

TimeProvider

+

Gets or sets a used internally by MagicOnion.

+
+
+ +
+ 
public TimeProvider? TimeProvider { get; set; }
+
+ + + + + +
+
Property Value
+
+
System.Nullable<TimeProvider>
+
+
+
+ + + + + + + +
diff --git a/api/toc.html b/api/toc.html index ceb6fa0f0..2dfd9ebed 100644 --- a/api/toc.html +++ b/api/toc.html @@ -624,6 +624,16 @@ +
  • + + MagicOnion.Server.Features + + +
  • MagicOnion.Server.Filters diff --git a/manifest.json b/manifest.json index b247864be..f347c4ce3 100644 --- a/manifest.json +++ b/manifest.json @@ -1923,6 +1923,30 @@ "is_incremental": false, "version": "" }, + { + "type": "ManagedReference", + "source_relative_path": "api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.yml", + "output": { + ".html": { + "relative_path": "api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html", + "hash": "wVOq+HPdBPjgWTKTm0Wcf7yVx7Y5O/t1DPJHMkimNPA=" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/MagicOnion.Server.Features.yml", + "output": { + ".html": { + "relative_path": "api/MagicOnion.Server.Features.html", + "hash": "CORPBFZPvbw9F4RJSf8WL5/roUOFuJaXl3S6n4y4Y88=" + } + }, + "is_incremental": false, + "version": "" + }, { "type": "ManagedReference", "source_relative_path": "api/MagicOnion.Server.Filters.IMagicOnionFilterFactory-1.yml", @@ -2673,7 +2697,7 @@ "output": { ".html": { "relative_path": "api/MagicOnion.Server.MagicOnionOptions.html", - "hash": "vP27hXzBcQ0VhZM/LAgmJN/xCOX8b05/v+HU53gfcHI=" + "hash": "Nkh8Yn8bj2czs3KLcMitYy61eac+1zgZ2WVwcXxVHJw=" } }, "is_incremental": false, @@ -2901,7 +2925,7 @@ "output": { ".html": { "relative_path": "api/toc.html", - "hash": "0I+05pRMADS7e/GOWin53VP28SN2lZ+rqUgIETqGxpk=" + "hash": "l3w5smoYZGIh8GrvBpg4bk604hCVLQt3i6a7RSHsuKI=" } }, "is_incremental": false, @@ -2988,7 +3012,7 @@ "ManagedReferenceDocumentProcessor": { "can_incremental": false, "incrementalPhase": "build", - "total_file_count": 241, + "total_file_count": 243, "skipped_file_count": 0 }, "TocDocumentProcessor": { diff --git a/xrefmap.yml b/xrefmap.yml index a3d02cdfa..9b3fe7cae 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -9963,6 +9963,70 @@ references: fullName.vb: MagicOnion.Server.DuplexStreamingContext(Of TRequest, TResponse).WriteOptions nameWithType: DuplexStreamingContext.WriteOptions nameWithType.vb: DuplexStreamingContext(Of TRequest, TResponse).WriteOptions +- uid: MagicOnion.Server.Features + name: MagicOnion.Server.Features + href: api/MagicOnion.Server.Features.html + commentId: N:MagicOnion.Server.Features + fullName: MagicOnion.Server.Features + nameWithType: MagicOnion.Server.Features +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature + name: IMagicOnionHeartbeatFeature + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html + commentId: T:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature + nameWithType: IMagicOnionHeartbeatFeature +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt + name: LastReceivedAt + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_LastReceivedAt + commentId: P:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt + nameWithType: IMagicOnionHeartbeatFeature.LastReceivedAt +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt* + name: LastReceivedAt + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_LastReceivedAt_ + commentId: Overload:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt + isSpec: "True" + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.LastReceivedAt + nameWithType: IMagicOnionHeartbeatFeature.LastReceivedAt +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency + name: Latency + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Latency + commentId: P:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency + nameWithType: IMagicOnionHeartbeatFeature.Latency +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency* + name: Latency + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Latency_ + commentId: Overload:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency + isSpec: "True" + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Latency + nameWithType: IMagicOnionHeartbeatFeature.Latency +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken + name: TimeoutToken + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_TimeoutToken + commentId: P:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken + nameWithType: IMagicOnionHeartbeatFeature.TimeoutToken +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken* + name: TimeoutToken + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_TimeoutToken_ + commentId: Overload:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken + isSpec: "True" + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.TimeoutToken + nameWithType: IMagicOnionHeartbeatFeature.TimeoutToken +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister + name: Unregister() + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Unregister + commentId: M:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister() + nameWithType: IMagicOnionHeartbeatFeature.Unregister() +- uid: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister* + name: Unregister + href: api/MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.html#MagicOnion_Server_Features_IMagicOnionHeartbeatFeature_Unregister_ + commentId: Overload:MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister + isSpec: "True" + fullName: MagicOnion.Server.Features.IMagicOnionHeartbeatFeature.Unregister + nameWithType: IMagicOnionHeartbeatFeature.Unregister - uid: MagicOnion.Server.Filters name: MagicOnion.Server.Filters href: api/MagicOnion.Server.Filters.html @@ -13290,6 +13354,19 @@ references: isSpec: "True" fullName: MagicOnion.Server.MagicOnionOptions.StreamingHubHeartbeatTimeout nameWithType: MagicOnionOptions.StreamingHubHeartbeatTimeout +- uid: MagicOnion.Server.MagicOnionOptions.TimeProvider + name: TimeProvider + href: api/MagicOnion.Server.MagicOnionOptions.html#MagicOnion_Server_MagicOnionOptions_TimeProvider + commentId: P:MagicOnion.Server.MagicOnionOptions.TimeProvider + fullName: MagicOnion.Server.MagicOnionOptions.TimeProvider + nameWithType: MagicOnionOptions.TimeProvider +- uid: MagicOnion.Server.MagicOnionOptions.TimeProvider* + name: TimeProvider + href: api/MagicOnion.Server.MagicOnionOptions.html#MagicOnion_Server_MagicOnionOptions_TimeProvider_ + commentId: Overload:MagicOnion.Server.MagicOnionOptions.TimeProvider + isSpec: "True" + fullName: MagicOnion.Server.MagicOnionOptions.TimeProvider + nameWithType: MagicOnionOptions.TimeProvider - uid: MagicOnion.Server.MagicOnionServiceDefinition name: MagicOnionServiceDefinition href: api/MagicOnion.Server.MagicOnionServiceDefinition.html