-
Notifications
You must be signed in to change notification settings - Fork 112
/
IHubProtocol.xml
314 lines (314 loc) · 19.7 KB
/
IHubProtocol.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
<Type Name="IHubProtocol" FullName="Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol">
<TypeSignature Language="C++ CLI" Value="public interface class IHubProtocol" />
<TypeSignature Language="C#" Value="public interface IHubProtocol" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IHubProtocol" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol" />
<TypeSignature Language="VB.NET" Value="Public Interface IHubProtocol" />
<TypeSignature Language="F#" Value="type IHubProtocol = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IHubProtocol" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A protocol abstraction for communicating with SignalR hubs.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetMessageBytes">
<MemberSignature Language="C++ CLI" Value="public:
 ReadOnlyMemory<System::Byte> GetMessageBytes(Microsoft::AspNetCore::SignalR::Protocol::HubMessage ^ message);" />
<MemberSignature Language="C#" Value="public ReadOnlyMemory<byte> GetMessageBytes (Microsoft.AspNetCore.SignalR.Protocol.HubMessage message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.ReadOnlyMemory`1<unsigned int8> GetMessageBytes(class Microsoft.AspNetCore.SignalR.Protocol.HubMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.GetMessageBytes(Microsoft.AspNetCore.SignalR.Protocol.HubMessage)" />
<MemberSignature Language="VB.NET" Value="Public Function GetMessageBytes (message As HubMessage) As ReadOnlyMemory(Of Byte)" />
<MemberSignature Language="F#" Value="abstract member GetMessageBytes : Microsoft.AspNetCore.SignalR.Protocol.HubMessage -> ReadOnlyMemory<byte>" Usage="iHubProtocol.GetMessageBytes message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(0)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.ReadOnlyMemory<System.Byte></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.AspNetCore.SignalR.Protocol.HubMessage">
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(1)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="message">The message to convert.</param>
<summary>
Converts the specified <see cref="T:Microsoft.AspNetCore.SignalR.Protocol.HubMessage" /> to its serialized representation.
</summary>
<returns>The serialized representation of the message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsVersionSupported">
<MemberSignature Language="C++ CLI" Value="public:
 bool IsVersionSupported(int version);" />
<MemberSignature Language="C#" Value="public bool IsVersionSupported (int version);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsVersionSupported(int32 version) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.IsVersionSupported(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function IsVersionSupported (version As Integer) As Boolean" />
<MemberSignature Language="F#" Value="abstract member IsVersionSupported : int -> bool" Usage="iHubProtocol.IsVersionSupported version" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="version" Type="System.Int32" />
</Parameters>
<Docs>
<param name="version">The version.</param>
<summary>
Gets a value indicating whether the protocol supports the specified version.
</summary>
<returns>A value indicating whether the protocol supports the specified version.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); };" />
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the protocol. The name is used by SignalR to resolve the protocol between the client and server.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TransferFormat">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Connections::TransferFormat TransferFormat { Microsoft::AspNetCore::Connections::TransferFormat get(); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Connections.TransferFormat TransferFormat { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.AspNetCore.Connections.TransferFormat TransferFormat" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.TransferFormat" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TransferFormat As TransferFormat" />
<MemberSignature Language="F#" Value="member this.TransferFormat : Microsoft.AspNetCore.Connections.TransferFormat" Usage="Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.TransferFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Connections.TransferFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the transfer format of the protocol.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryParseMessage">
<MemberSignature Language="C++ CLI" Value="public:
 bool TryParseMessage(System::Buffers::ReadOnlySequence<System::Byte> % input, Microsoft::AspNetCore::SignalR::IInvocationBinder ^ binder, [Runtime::InteropServices::Out] Microsoft::AspNetCore::SignalR::Protocol::HubMessage ^ % message);" />
<MemberSignature Language="C#" Value="public bool TryParseMessage (ref System.Buffers.ReadOnlySequence<byte> input, Microsoft.AspNetCore.SignalR.IInvocationBinder binder, out Microsoft.AspNetCore.SignalR.Protocol.HubMessage message);" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryParseMessage(valuetype System.Buffers.ReadOnlySequence`1<unsigned int8>& input, class Microsoft.AspNetCore.SignalR.IInvocationBinder binder, [out] class Microsoft.AspNetCore.SignalR.Protocol.HubMessage& message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.TryParseMessage(System.Buffers.ReadOnlySequence{System.Byte}@,Microsoft.AspNetCore.SignalR.IInvocationBinder,Microsoft.AspNetCore.SignalR.Protocol.HubMessage@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryParseMessage (ByRef input As ReadOnlySequence(Of Byte), binder As IInvocationBinder, ByRef message As HubMessage) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryParseMessage : ReadOnlySequence * Microsoft.AspNetCore.SignalR.IInvocationBinder * HubMessage -> bool" Usage="iHubProtocol.TryParseMessage (input, binder, message)" />
<MemberSignature Language="C#" Value="public bool TryParseMessage (ref System.Buffers.ReadOnlySequence<byte> input, Microsoft.AspNetCore.SignalR.IInvocationBinder binder, out Microsoft.AspNetCore.SignalR.Protocol.HubMessage? message);" FrameworkAlternate="aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(0)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="input" Type="System.Buffers.ReadOnlySequence<System.Byte>" RefType="ref" />
<Parameter Name="binder" Type="Microsoft.AspNetCore.SignalR.IInvocationBinder">
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(1)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="message" Type="Microsoft.AspNetCore.SignalR.Protocol.HubMessage" RefType="out">
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.NotNullWhen(true)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.NotNullWhen(true)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="input">The serialized representation of the message.</param>
<param name="binder">The binder used to parse the message.</param>
<param name="message">When this method returns <c>true</c>, contains the parsed message.</param>
<summary>
Creates a new <see cref="T:Microsoft.AspNetCore.SignalR.Protocol.HubMessage" /> from the specified serialized representation, and using the specified binder.
</summary>
<returns>A value that is <c>true</c> if the <see cref="T:Microsoft.AspNetCore.SignalR.Protocol.HubMessage" /> was successfully parsed; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C++ CLI" Value="public:
 property int Version { int get(); };" />
<MemberSignature Language="C#" Value="public int Version { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Version" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.Version" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As Integer" />
<MemberSignature Language="F#" Value="member this.Version : int" Usage="Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.Version" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the major version of the protocol.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteMessage">
<MemberSignature Language="C++ CLI" Value="public:
 void WriteMessage(Microsoft::AspNetCore::SignalR::Protocol::HubMessage ^ message, System::Buffers::IBufferWriter<System::Byte> ^ output);" />
<MemberSignature Language="C#" Value="public void WriteMessage (Microsoft.AspNetCore.SignalR.Protocol.HubMessage message, System.Buffers.IBufferWriter<byte> output);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteMessage(class Microsoft.AspNetCore.SignalR.Protocol.HubMessage message, class System.Buffers.IBufferWriter`1<unsigned int8> output) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol.WriteMessage(Microsoft.AspNetCore.SignalR.Protocol.HubMessage,System.Buffers.IBufferWriter{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteMessage (message As HubMessage, output As IBufferWriter(Of Byte))" />
<MemberSignature Language="F#" Value="abstract member WriteMessage : Microsoft.AspNetCore.SignalR.Protocol.HubMessage * System.Buffers.IBufferWriter<byte> -> unit" Usage="iHubProtocol.WriteMessage (message, output)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.SignalR.Common</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.AspNetCore.SignalR.Protocol.HubMessage" />
<Parameter Name="output" Type="System.Buffers.IBufferWriter<System.Byte>" />
</Parameters>
<Docs>
<param name="message">The message to write.</param>
<param name="output">The output writer.</param>
<summary>
Writes the specified <see cref="T:Microsoft.AspNetCore.SignalR.Protocol.HubMessage" /> to a writer.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>