-
Notifications
You must be signed in to change notification settings - Fork 257
/
HybridConnectionStream.xml
256 lines (256 loc) · 14.6 KB
/
HybridConnectionStream.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
<Type Name="HybridConnectionStream" FullName="Microsoft.Azure.Relay.HybridConnectionStream">
<TypeSignature Language="C#" Value="public abstract class HybridConnectionStream : System.IO.Stream" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit HybridConnectionStream extends System.IO.Stream" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Relay.HybridConnectionStream" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class HybridConnectionStream
Inherits Stream" />
<TypeSignature Language="F#" Value="type HybridConnectionStream = class
 inherit Stream" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IO.Stream</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A Stream representing a connected HybridConnection. Use it just like any other Stream with the addition of a
Shutdown method for notifying the other side of this connection that shutdown is occurring.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CloseAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CloseAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.CloseAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function CloseAsync (cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="member this.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="hybridConnectionStream.CloseAsync cancellationToken" />
<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.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A cancellation token to observe.</param>
<summary>
Closes this <see cref="T:Microsoft.Azure.Relay.HybridConnectionStream" /> instance asynchronously using a <see cref="T:System.Threading.CancellationToken" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="hybridConnectionStream.Dispose disposing" />
<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="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
<summary>
Closes this <see cref="T:Microsoft.Azure.Relay.HybridConnectionStream" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCloseAsync">
<MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task OnCloseAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnCloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.OnCloseAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnCloseAsync (cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="abstract member OnCloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="hybridConnectionStream.OnCloseAsync cancellationToken" />
<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.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A cancellation token to observe.</param>
<summary>
Derived classes implement close logic in this method.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnShutdownAsync">
<MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task OnShutdownAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnShutdownAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.OnShutdownAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnShutdownAsync (cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="abstract member OnShutdownAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="hybridConnectionStream.OnShutdownAsync cancellationToken" />
<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.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A cancellation token to observe.</param>
<summary>
Derived classes implement shutdown logic in this method.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="C#" Value="public virtual void Shutdown ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Shutdown() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.Shutdown" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Shutdown ()" />
<MemberSignature Language="F#" Value="abstract member Shutdown : unit -> unit
override this.Shutdown : unit -> unit" Usage="hybridConnectionStream.Shutdown " />
<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 />
<Docs>
<summary>
Initiates a graceful close process by shutting down sending through this
<see cref="T:Microsoft.Azure.Relay.HybridConnectionStream" />. To disconnect cleanly and asynchronously, call Shutdown,
wait for Read/ReadAsync to complete with a 0 byte read, then finally call Stream.Close();
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShutdownAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ShutdownAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task ShutdownAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.ShutdownAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ShutdownAsync (cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="member this.ShutdownAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="hybridConnectionStream.ShutdownAsync cancellationToken" />
<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.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A cancellation token to observe.</param>
<summary>
Initiates a graceful close process by shutting down sending through this
<see cref="T:Microsoft.Azure.Relay.HybridConnectionStream" />. To disconnect cleanly and asynchronously, call ShutdownAsync,
wait for Read/ReadAsync to complete with a 0 byte read, then finally call Stream.CloseAsync();
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Relay.HybridConnectionStream.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="hybridConnectionStream.ToString " />
<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.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a string that represents the current object. Includes a TrackingId for end to end correlation.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrackingContext">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Relay.TrackingContext TrackingContext { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Relay.TrackingContext TrackingContext" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.HybridConnectionStream.TrackingContext" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TrackingContext As TrackingContext" />
<MemberSignature Language="F#" Value="member this.TrackingContext : Microsoft.Azure.Relay.TrackingContext" Usage="Microsoft.Azure.Relay.HybridConnectionStream.TrackingContext" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Relay.TrackingContext</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the TrackingContext for this stream.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Relay.WriteMode WriteMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Relay.WriteMode WriteMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Relay.HybridConnectionStream.WriteMode" />
<MemberSignature Language="VB.NET" Value="Public Property WriteMode As WriteMode" />
<MemberSignature Language="F#" Value="member this.WriteMode : Microsoft.Azure.Relay.WriteMode with get, set" Usage="Microsoft.Azure.Relay.HybridConnectionStream.WriteMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Relay</AssemblyName>
<AssemblyVersion>2.0.1559.6</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Relay.WriteMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Sets or gets the WriteMode for this stream. Default is WriteMode.Binary
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>