-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WebSocketCreationOptions.xml
153 lines (153 loc) · 9.15 KB
/
WebSocketCreationOptions.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
<Type Name="WebSocketCreationOptions" FullName="System.Net.WebSockets.WebSocketCreationOptions">
<TypeSignature Language="C#" Value="public sealed class WebSocketCreationOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit WebSocketCreationOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Net.WebSockets.WebSocketCreationOptions" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class WebSocketCreationOptions" />
<TypeSignature Language="F#" Value="type WebSocketCreationOptions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class WebSocketCreationOptions sealed" />
<AssemblyInfo>
<AssemblyName>System.Net.WebSockets</AssemblyName>
<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="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Options that control how a <see cref="T:System.Net.WebSockets.WebSocket" /> is created.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebSocketCreationOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.WebSockets.WebSocketCreationOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 WebSocketCreationOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.WebSockets</AssemblyName>
<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>Creates an instance of the <see cref="T:System.Net.WebSockets.WebSocketCreationOptions" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DangerousDeflateOptions">
<MemberSignature Language="C#" Value="public System.Net.WebSockets.WebSocketDeflateOptions? DangerousDeflateOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.WebSockets.WebSocketDeflateOptions DangerousDeflateOptions" />
<MemberSignature Language="DocId" Value="P:System.Net.WebSockets.WebSocketCreationOptions.DangerousDeflateOptions" />
<MemberSignature Language="VB.NET" Value="Public Property DangerousDeflateOptions As WebSocketDeflateOptions" />
<MemberSignature Language="F#" Value="member this.DangerousDeflateOptions : System.Net.WebSockets.WebSocketDeflateOptions with get, set" Usage="System.Net.WebSockets.WebSocketCreationOptions.DangerousDeflateOptions" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Net::WebSockets::WebSocketDeflateOptions ^ DangerousDeflateOptions { System::Net::WebSockets::WebSocketDeflateOptions ^ get(); void set(System::Net::WebSockets::WebSocketDeflateOptions ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.WebSockets</AssemblyName>
<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.Net.WebSockets.WebSocketDeflateOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>The agreed upon options for per message deflate.<para /> Be aware that enabling compression makes the application subject to CRIME/BREACH type of attacks.
It is strongly advised to turn off compression when sending data containing secrets by specifying <see cref="F:System.Net.WebSockets.WebSocketMessageFlags.DisableCompression" /> flag for such messages.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsServer">
<MemberSignature Language="C#" Value="public bool IsServer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsServer" />
<MemberSignature Language="DocId" Value="P:System.Net.WebSockets.WebSocketCreationOptions.IsServer" />
<MemberSignature Language="VB.NET" Value="Public Property IsServer As Boolean" />
<MemberSignature Language="F#" Value="member this.IsServer : bool with get, set" Usage="System.Net.WebSockets.WebSocketCreationOptions.IsServer" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsServer { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.WebSockets</AssemblyName>
<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>
<Docs>
<summary>Defines if this websocket is the server-side of the connection. The default value is <see langword="false" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KeepAliveInterval">
<MemberSignature Language="C#" Value="public TimeSpan KeepAliveInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan KeepAliveInterval" />
<MemberSignature Language="DocId" Value="P:System.Net.WebSockets.WebSocketCreationOptions.KeepAliveInterval" />
<MemberSignature Language="VB.NET" Value="Public Property KeepAliveInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.KeepAliveInterval : TimeSpan with get, set" Usage="System.Net.WebSockets.WebSocketCreationOptions.KeepAliveInterval" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan KeepAliveInterval { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.WebSockets</AssemblyName>
<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>The keep-alive interval to use, or <see cref="F:System.TimeSpan.Zero" /> or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable keep-alives.
The default is <see cref="F:System.TimeSpan.Zero" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SubProtocol">
<MemberSignature Language="C#" Value="public string? SubProtocol { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SubProtocol" />
<MemberSignature Language="DocId" Value="P:System.Net.WebSockets.WebSocketCreationOptions.SubProtocol" />
<MemberSignature Language="VB.NET" Value="Public Property SubProtocol As String" />
<MemberSignature Language="F#" Value="member this.SubProtocol : string with get, set" Usage="System.Net.WebSockets.WebSocketCreationOptions.SubProtocol" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ SubProtocol { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.WebSockets</AssemblyName>
<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>The agreed upon sub-protocol that was used when creating the connection.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>