-
Notifications
You must be signed in to change notification settings - Fork 112
/
WebSocketOptions.xml
129 lines (129 loc) · 7.73 KB
/
WebSocketOptions.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
<Type Name="WebSocketOptions" FullName="Microsoft.AspNetCore.Http.Connections.WebSocketOptions">
<TypeSignature Language="C++ CLI" Value="public ref class WebSocketOptions" />
<TypeSignature Language="C#" Value="public class WebSocketOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebSocketOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Http.Connections.WebSocketOptions" />
<TypeSignature Language="VB.NET" Value="Public Class WebSocketOptions" />
<TypeSignature Language="F#" Value="type WebSocketOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Connections</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options used by the WebSockets transport to modify the transports behavior.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 WebSocketOptions();" />
<MemberSignature Language="C#" Value="public WebSocketOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.Connections.WebSocketOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Connections</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.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>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloseTimeout">
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan CloseTimeout { TimeSpan get(); void set(TimeSpan value); };" />
<MemberSignature Language="C#" Value="public TimeSpan CloseTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan CloseTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.Connections.WebSocketOptions.CloseTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property CloseTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.CloseTimeout : TimeSpan with get, set" Usage="Microsoft.AspNetCore.Http.Connections.WebSocketOptions.CloseTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Connections</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.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.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the amount of time the WebSocket transport will wait for a graceful close before starting an ungraceful close.
</summary>
<value>Defaults to 5 seconds</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SubProtocolSelector">
<MemberSignature Language="C++ CLI" Value="public:
 property Func<System::Collections::Generic::IList<System::String ^> ^, System::String ^> ^ SubProtocolSelector { Func<System::Collections::Generic::IList<System::String ^> ^, System::String ^> ^ get(); void set(Func<System::Collections::Generic::IList<System::String ^> ^, System::String ^> ^ value); };" />
<MemberSignature Language="C#" Value="public Func<System.Collections.Generic.IList<string>,string> SubProtocolSelector { get; set; }" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class System.Collections.Generic.IList`1<string>, string> SubProtocolSelector" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.Connections.WebSocketOptions.SubProtocolSelector" />
<MemberSignature Language="VB.NET" Value="Public Property SubProtocolSelector As Func(Of IList(Of String), String)" />
<MemberSignature Language="F#" Value="member this.SubProtocolSelector : Func<System.Collections.Generic.IList<string>, string> with get, set" Usage="Microsoft.AspNetCore.Http.Connections.WebSocketOptions.SubProtocolSelector" />
<MemberSignature Language="C#" Value="public Func<System.Collections.Generic.IList<string>,string>? SubProtocolSelector { get; set; }" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Connections</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.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.Nullable(new System.Byte[] { 2, 1, 1, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1, 1, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Func<System.Collections.Generic.IList<System.String>,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a delegate that will be called when a new WebSocket is established to select the value
for the 'Sec-WebSocket-Protocol' response header. The delegate will be called with a list of the protocols provided
by the client in the 'Sec-WebSocket-Protocol' request header.
</summary>
<value>To be added.</value>
<remarks>
See RFC 6455 section 1.3 for more details on the WebSocket handshake: <see href="https://tools.ietf.org/html/rfc6455#section-1.3" /></remarks>
</Docs>
</Member>
</Members>
</Type>