-
Notifications
You must be signed in to change notification settings - Fork 112
/
WebSocketOptions.xml
218 lines (218 loc) · 11.5 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
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
<Type Name="WebSocketOptions" FullName="Microsoft.AspNetCore.Builder.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.Builder.WebSocketOptions" />
<TypeSignature Language="VB.NET" Value="Public Class WebSocketOptions" />
<TypeSignature Language="F#" Value="type WebSocketOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets.Server</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.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 />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<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>
Configuration options for the WebSocketMiddleware.
</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.Builder.WebSocketOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets.Server</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.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>
Constructs the <see cref="T:Microsoft.AspNetCore.Builder.WebSocketOptions" /> class with default values.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AllowedOrigins">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IList<System::String ^> ^ AllowedOrigins { System::Collections::Generic::IList<System::String ^> ^ get(); };" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> AllowedOrigins { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> AllowedOrigins" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.WebSocketOptions.AllowedOrigins" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AllowedOrigins As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.AllowedOrigins : System.Collections.Generic.IList<string>" Usage="Microsoft.AspNetCore.Builder.WebSocketOptions.AllowedOrigins" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets</AssemblyName>
<AssemblyVersion>2.2.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.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Set the Origin header values allowed for WebSocket requests to prevent Cross-Site WebSocket Hijacking.
By default all Origins are allowed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KeepAliveInterval">
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan KeepAliveInterval { TimeSpan get(); void set(TimeSpan value); };" />
<MemberSignature Language="C#" Value="public TimeSpan KeepAliveInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan KeepAliveInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.WebSocketOptions.KeepAliveInterval" />
<MemberSignature Language="VB.NET" Value="Public Property KeepAliveInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.KeepAliveInterval : TimeSpan with get, set" Usage="Microsoft.AspNetCore.Builder.WebSocketOptions.KeepAliveInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets.Server</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.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 frequency at which to send Ping/Pong keep-alive control frames.
The default is two minutes.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveBufferSize">
<MemberSignature Language="C++ CLI" Value="public:
 property int ReceiveBufferSize { int get(); void set(int value); };" />
<MemberSignature Language="C#" Value="public int ReceiveBufferSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ReceiveBufferSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.WebSocketOptions.ReceiveBufferSize" />
<MemberSignature Language="VB.NET" Value="Public Property ReceiveBufferSize As Integer" />
<MemberSignature Language="F#" Value="member this.ReceiveBufferSize : int with get, set" Usage="Microsoft.AspNetCore.Builder.WebSocketOptions.ReceiveBufferSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets.Server</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.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-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Obsolete("Setting this property has no effect. It will be removed in a future version.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Setting this property has no effect. It will be removed in a future version.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the size of the protocol buffer used to receive and parse frames.
The default is 4kb.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReplaceFeature">
<MemberSignature Language="C++ CLI" Value="public:
 property bool ReplaceFeature { bool get(); void set(bool value); };" />
<MemberSignature Language="C#" Value="public bool ReplaceFeature { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ReplaceFeature" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.WebSocketOptions.ReplaceFeature" />
<MemberSignature Language="VB.NET" Value="Public Property ReplaceFeature As Boolean" />
<MemberSignature Language="F#" Value="member this.ReplaceFeature : bool with get, set" Usage="Microsoft.AspNetCore.Builder.WebSocketOptions.ReplaceFeature" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.WebSockets.Server</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets if the middleware should replace the WebSocket implementation provided by
a component earlier in the stack. This is false by default.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>