-
Notifications
You must be signed in to change notification settings - Fork 256
/
IClientWebSocketOptions.xml
149 lines (149 loc) · 7.66 KB
/
IClientWebSocketOptions.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
<Type Name="IClientWebSocketOptions" FullName="Microsoft.Azure.Relay.IClientWebSocketOptions">
<TypeSignature Language="C#" Value="public interface IClientWebSocketOptions" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IClientWebSocketOptions" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Relay.IClientWebSocketOptions" />
<TypeSignature Language="VB.NET" Value="Public Interface IClientWebSocketOptions" />
<TypeSignature Language="F#" Value="type IClientWebSocketOptions = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Client Websocket Options interface.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddSubProtocol">
<MemberSignature Language="C#" Value="public void AddSubProtocol (string subProtocol);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddSubProtocol(string subProtocol) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.IClientWebSocketOptions.AddSubProtocol(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddSubProtocol (subProtocol As String)" />
<MemberSignature Language="F#" Value="abstract member AddSubProtocol : string -> unit" Usage="iClientWebSocketOptions.AddSubProtocol subProtocol" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subProtocol" Type="System.String" />
</Parameters>
<Docs>
<param name="subProtocol">The WebSocket sub-protocol to add.</param>
<summary>
Adds a sub-protocol to be negotiated during the WebSocket connection handshake.
</summary>
<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:Microsoft.Azure.Relay.IClientWebSocketOptions.KeepAliveInterval" />
<MemberSignature Language="VB.NET" Value="Public Property KeepAliveInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.KeepAliveInterval : TimeSpan with get, set" Usage="Microsoft.Azure.Relay.IClientWebSocketOptions.KeepAliveInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the WebSocket protocol keep-alive interval.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Proxy">
<MemberSignature Language="C#" Value="public System.Net.IWebProxy Proxy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy Proxy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.IClientWebSocketOptions.Proxy" />
<MemberSignature Language="VB.NET" Value="Public Property Proxy As IWebProxy" />
<MemberSignature Language="F#" Value="member this.Proxy : System.Net.IWebProxy with get, set" Usage="Microsoft.Azure.Relay.IClientWebSocketOptions.Proxy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.IWebProxy</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the proxy for WebSocket requests.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetBuffer">
<MemberSignature Language="C#" Value="public void SetBuffer (int receiveBufferSize, int sendBufferSize);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetBuffer(int32 receiveBufferSize, int32 sendBufferSize) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.IClientWebSocketOptions.SetBuffer(System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetBuffer (receiveBufferSize As Integer, sendBufferSize As Integer)" />
<MemberSignature Language="F#" Value="abstract member SetBuffer : int * int -> unit" Usage="iClientWebSocketOptions.SetBuffer (receiveBufferSize, sendBufferSize)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="receiveBufferSize" Type="System.Int32" />
<Parameter Name="sendBufferSize" Type="System.Int32" />
</Parameters>
<Docs>
<param name="receiveBufferSize">The size, in bytes, of the client receive buffer.</param>
<param name="sendBufferSize">The size, in bytes, of the client send buffer.</param>
<summary>
Sets the client buffer parameters.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetRequestHeader">
<MemberSignature Language="C#" Value="public void SetRequestHeader (string name, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetRequestHeader(string name, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.IClientWebSocketOptions.SetRequestHeader(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetRequestHeader (name As String, value As String)" />
<MemberSignature Language="F#" Value="abstract member SetRequestHeader : string * string -> unit" Usage="iClientWebSocketOptions.SetRequestHeader (name, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the HTTP header.</param>
<param name="value">The value of the HTTP header.</param>
<summary>
Creates a HTTP request header and its value.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>