/
IContextChannel.xml
322 lines (312 loc) · 20.3 KB
/
IContextChannel.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<Type Name="IContextChannel" FullName="System.ServiceModel.IContextChannel">
<TypeSignature Language="C#" Value="public interface IContextChannel : System.ServiceModel.Channels.IChannel, System.ServiceModel.IExtensibleObject<System.ServiceModel.IContextChannel>" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IContextChannel implements class System.ServiceModel.Channels.IChannel, class System.ServiceModel.ICommunicationObject, class System.ServiceModel.IExtensibleObject`1<class System.ServiceModel.IContextChannel>" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.IContextChannel" />
<TypeSignature Language="VB.NET" Value="Public Interface IContextChannel
Implements IChannel, IExtensibleObject(Of IContextChannel)" />
<TypeSignature Language="F#" Value="type IContextChannel = interface
 interface IChannel
 interface ICommunicationObject
 interface IExtensibleObject<IContextChannel>" />
<TypeSignature Language="C++ CLI" Value="public interface class IContextChannel : System::ServiceModel::Channels::IChannel, System::ServiceModel::IExtensibleObject<System::ServiceModel::IContextChannel ^>" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IContextChannel implements class System.ServiceModel.Channels.IChannel, class System.ServiceModel.ICommunicationObject, class System.ServiceModel.IExtensibleObject`1<class System.ServiceModel.IContextChannel>" FrameworkAlternate="net-8.0" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.7.0.0</AssemblyVersion>
<AssemblyVersion>4.9.0.0</AssemblyVersion>
<AssemblyVersion>4.10.0.0</AssemblyVersion>
<AssemblyVersion>4.10.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="System.ServiceModel" FromVersion="4.0.0.0" To="System.ServiceModel.Primitives" ToVersion="0.0.0.0" FrameworkAlternate="dotnet-uwp-10.0" />
</TypeForwardingChain>
<Interfaces>
<Interface>
<InterfaceName>System.ServiceModel.Channels.IChannel</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.ServiceModel.ICommunicationObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.ServiceModel.IExtensibleObject<System.ServiceModel.IContextChannel></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Defines the interface for the context control of a channel.</summary>
<remarks>
<format type="text/markdown"><]
The <xref:System.ServiceModel.IContextChannel> defines the controls for the context of a channel. This includes the <xref:System.ServiceModel.IContextChannel.SessionId%2A>, <xref:System.ServiceModel.IContextChannel.InputSession%2A>, <xref:System.ServiceModel.IContextChannel.OutputSession%2A>, and <xref:System.ServiceModel.IContextChannel.AllowOutputBatching%2A> for the channel, and the <xref:System.ServiceModel.IContextChannel.LocalAddress%2A> and <xref:System.ServiceModel.IContextChannel.RemoteAddress%2A> for the endpoints participating in the session. The <xref:System.ServiceModel.IContextChannel> interface forms part of the <xref:System.ServiceModel.IServiceChannel> and <xref:System.ServiceModel.IClientChannel> interfaces and of the <xref:System.ServiceModel.IDuplexContextChannel> interface.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="AllowOutputBatching">
<MemberSignature Language="C#" Value="public bool AllowOutputBatching { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowOutputBatching" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.AllowOutputBatching" />
<MemberSignature Language="VB.NET" Value="Public Property AllowOutputBatching As Boolean" />
<MemberSignature Language="F#" Value="member this.AllowOutputBatching : bool with get, set" Usage="System.ServiceModel.IContextChannel.AllowOutputBatching" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AllowOutputBatching { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that instructs Windows Communication Foundation (WCF) to store a set of messages before giving the messages to the transport.</summary>
<value>
<see langword="true" /> if the batching of outgoing messages is allowed; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The level of batching affects the performance of the system. When you set the value to `true`, you are instructing the system to hold on to this message in a local buffer to send out with other serialized messages if possible. Set the <xref:System.ServiceModel.IContextChannel.AllowOutputBatching%2A> property to `true` if message throughput is important; set it to `false` if reducing latency is important. There are other knobs used to manage the batching of messages that are accessible from the binding elements used to configure a service. Properties common to connection-oriented transports such as TCP and named pipes that are used to tune performance are located, for example, on the <xref:System.ServiceModel.Channels.ConnectionOrientedTransportBindingElement>. The <xref:System.ServiceModel.Channels.ConnectionOrientedTransportBindingElement.MaxOutputDelay%2A> is used to set the maximum interval of time that a chunk of a message or a full message can remain buffered in memory before being sent out and the <xref:System.ServiceModel.Channels.ConnectionOrientedTransportBindingElement.ConnectionBufferSize%2A> determines the size of this local buffer, as well as the buffer sizes used by the underlying network objects.
The value of <xref:System.ServiceModel.IContextChannel.AllowOutputBatching%2A> does not override the value of the <xref:System.ServiceModel.Channels.MessageProperties.AllowOutputBatching%2A> property that is set at the channel level. For example, if <xref:System.ServiceModel.Channels.MessageProperties.AllowOutputBatching%2A> is set to `true` for a particular message, that message is sent immediately regardless of the value of <xref:System.ServiceModel.IContextChannel.AllowOutputBatching%2A>.
> [!NOTE]
> All request/reply messages are sent immediately regardless of the value of <xref:System.ServiceModel.IContextChannel.AllowOutputBatching%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="InputSession">
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.IInputSession InputSession { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Channels.IInputSession InputSession" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.InputSession" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InputSession As IInputSession" />
<MemberSignature Language="F#" Value="member this.InputSession : System.ServiceModel.Channels.IInputSession" Usage="System.ServiceModel.IContextChannel.InputSession" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::Channels::IInputSession ^ InputSession { System::ServiceModel::Channels::IInputSession ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.IInputSession</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the input session for the channel.</summary>
<value>The <see cref="T:System.ServiceModel.Channels.IInputSession" /> for the channel.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LocalAddress">
<MemberSignature Language="C#" Value="public System.ServiceModel.EndpointAddress LocalAddress { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.EndpointAddress LocalAddress" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.LocalAddress" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LocalAddress As EndpointAddress" />
<MemberSignature Language="F#" Value="member this.LocalAddress : System.ServiceModel.EndpointAddress" Usage="System.ServiceModel.IContextChannel.LocalAddress" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::EndpointAddress ^ LocalAddress { System::ServiceModel::EndpointAddress ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.EndpointAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the local endpoint for the channel.</summary>
<value>The local <see cref="T:System.ServiceModel.EndpointAddress" /> for the channel.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OperationTimeout">
<MemberSignature Language="C#" Value="public TimeSpan OperationTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan OperationTimeout" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.OperationTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property OperationTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.OperationTimeout : TimeSpan with get, set" Usage="System.ServiceModel.IContextChannel.OperationTimeout" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan OperationTimeout { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time period within which an operation must complete or an exception is thrown.</summary>
<value>The <see cref="T:System.TimeSpan" /> that specifies the time period within which an operation must complete.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If transaction flow is enabled on the binding or the channel, the operation may take longer to execute than the specified timeout. In these circumstances the operation will fail due to the expired timeout and the transaction will abort appropriately.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OutputSession">
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.IOutputSession OutputSession { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Channels.IOutputSession OutputSession" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.OutputSession" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OutputSession As IOutputSession" />
<MemberSignature Language="F#" Value="member this.OutputSession : System.ServiceModel.Channels.IOutputSession" Usage="System.ServiceModel.IContextChannel.OutputSession" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::Channels::IOutputSession ^ OutputSession { System::ServiceModel::Channels::IOutputSession ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.IOutputSession</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the output session associated with the channel, if any.</summary>
<value>A <see cref="T:System.ServiceModel.Channels.IOutputSession" /> implementation if an input session exists; otherwise, <see langword="null" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoteAddress">
<MemberSignature Language="C#" Value="public System.ServiceModel.EndpointAddress RemoteAddress { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.EndpointAddress RemoteAddress" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.RemoteAddress" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RemoteAddress As EndpointAddress" />
<MemberSignature Language="F#" Value="member this.RemoteAddress : System.ServiceModel.EndpointAddress" Usage="System.ServiceModel.IContextChannel.RemoteAddress" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::EndpointAddress ^ RemoteAddress { System::ServiceModel::EndpointAddress ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.EndpointAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the remote address associated with the channel.</summary>
<value>The remote <see cref="T:System.ServiceModel.EndpointAddress" /> for the channel.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SessionId">
<MemberSignature Language="C#" Value="public string SessionId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SessionId" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.IContextChannel.SessionId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SessionId As String" />
<MemberSignature Language="F#" Value="member this.SessionId : string" Usage="System.ServiceModel.IContextChannel.SessionId" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ SessionId { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an identifier for the current session, if any.</summary>
<value>The current session identifier, if any.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>