/
ChannelManagerService.xml
271 lines (241 loc) · 17.7 KB
/
ChannelManagerService.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
<Type Name="ChannelManagerService" FullName="System.Workflow.Runtime.Hosting.ChannelManagerService">
<TypeSignature Language="C#" Value="public sealed class ChannelManagerService : System.Workflow.Runtime.Hosting.WorkflowRuntimeService" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ChannelManagerService extends System.Workflow.Runtime.Hosting.WorkflowRuntimeService" />
<TypeSignature Language="DocId" Value="T:System.Workflow.Runtime.Hosting.ChannelManagerService" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ChannelManagerService
Inherits WorkflowRuntimeService" />
<TypeSignature Language="F#" Value="type ChannelManagerService = class
 inherit WorkflowRuntimeService" />
<TypeSignature Language="C++ CLI" Value="public ref class ChannelManagerService sealed : System::Workflow::Runtime::Hosting::WorkflowRuntimeService" />
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Workflow.Runtime.Hosting.WorkflowRuntimeService</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="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">
<AttributeName Language="C#">[System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides functionality for constructing client-side channels, caching channels, and channel factories.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
The <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> is responsible for creating a channel for a <xref:System.Workflow.Activities.SendActivity> based on the channel token defined in the activity's <xref:System.Workflow.Activities.SendActivity.ChannelToken%2A>.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Hosting.ChannelManagerService" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChannelManagerService ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 ChannelManagerService();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Hosting.ChannelManagerService" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates how to create a new instance of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> object. This example was adapted from the `SequentialWorkflowService` SDK sample.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet0":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet0":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChannelManagerService (System.Collections.Generic.IList<System.ServiceModel.Description.ServiceEndpoint> endpoints);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<class System.ServiceModel.Description.ServiceEndpoint> endpoints) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.#ctor(System.Collections.Generic.IList{System.ServiceModel.Description.ServiceEndpoint})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoints As IList(Of ServiceEndpoint))" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.Hosting.ChannelManagerService : System.Collections.Generic.IList<System.ServiceModel.Description.ServiceEndpoint> -> System.Workflow.Runtime.Hosting.ChannelManagerService" Usage="new System.Workflow.Runtime.Hosting.ChannelManagerService endpoints" />
<MemberSignature Language="C++ CLI" Value="public:
 ChannelManagerService(System::Collections::Generic::IList<System::ServiceModel::Description::ServiceEndpoint ^> ^ endpoints);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoints" Type="System.Collections.Generic.IList<System.ServiceModel.Description.ServiceEndpoint>" />
</Parameters>
<Docs>
<param name="endpoints">A collection of service endpoints.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Hosting.ChannelManagerService" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Instances of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> class are usually created by the runtime using configuration files.
The endpoints defined in the service's constructor will be used to create channels that match the configuration name in the <xref:System.Workflow.Activities.SendActivity.ChannelToken%2A>. The endpoints defined in the configuration take precedence over the endpoints defined in code, so if a service endpoint added through code has the same name and contract type as one in the configuration file, then the endpoint defined in code will not be used.
## Examples
The following example demonstrates how to create a new instance of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> object. This example was adapted from the `WorkflowServiceUtility` SDK sample.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChannelManagerService (System.Collections.Specialized.NameValueCollection parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Specialized.NameValueCollection parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.#ctor(System.Collections.Specialized.NameValueCollection)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (parameters As NameValueCollection)" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.Hosting.ChannelManagerService : System.Collections.Specialized.NameValueCollection -> System.Workflow.Runtime.Hosting.ChannelManagerService" Usage="new System.Workflow.Runtime.Hosting.ChannelManagerService parameters" />
<MemberSignature Language="C++ CLI" Value="public:
 ChannelManagerService(System::Collections::Specialized::NameValueCollection ^ parameters);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="parameters" Type="System.Collections.Specialized.NameValueCollection" />
</Parameters>
<Docs>
<param name="parameters">Configuration parameters for the service.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Hosting.ChannelManagerService" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following parameters are supported:
- `idleTimeout`: The maximum <xref:System.TimeSpan> that a cached channel can be idle.
- `leaseTimeout`: The maximum <xref:System.TimeSpan> that a cached channel can be checked out or in use by a <xref:System.Workflow.Activities.SendActivity>.
- `maxIdleChannelsPerEndpoint`: The maximum number of idle channels matching a single endpoint that can be cached at any point.
Instances of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> class are usually created by the runtime using configuration files.
## Examples
The following example demonstrates how to create a new instance of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> object.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChannelManagerService (System.ServiceModel.Channels.ChannelPoolSettings settings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.Channels.ChannelPoolSettings settings) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.#ctor(System.ServiceModel.Channels.ChannelPoolSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (settings As ChannelPoolSettings)" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.Hosting.ChannelManagerService : System.ServiceModel.Channels.ChannelPoolSettings -> System.Workflow.Runtime.Hosting.ChannelManagerService" Usage="new System.Workflow.Runtime.Hosting.ChannelManagerService settings" />
<MemberSignature Language="C++ CLI" Value="public:
 ChannelManagerService(System::ServiceModel::Channels::ChannelPoolSettings ^ settings);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="settings" Type="System.ServiceModel.Channels.ChannelPoolSettings" />
</Parameters>
<Docs>
<param name="settings">Settings for quotas for the pool of channels managed by this service.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Hosting.ChannelManagerService" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates how to create a new instance of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> object.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet3":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChannelManagerService (System.ServiceModel.Channels.ChannelPoolSettings settings, System.Collections.Generic.IList<System.ServiceModel.Description.ServiceEndpoint> endpoints);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.Channels.ChannelPoolSettings settings, class System.Collections.Generic.IList`1<class System.ServiceModel.Description.ServiceEndpoint> endpoints) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.#ctor(System.ServiceModel.Channels.ChannelPoolSettings,System.Collections.Generic.IList{System.ServiceModel.Description.ServiceEndpoint})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (settings As ChannelPoolSettings, endpoints As IList(Of ServiceEndpoint))" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.Hosting.ChannelManagerService : System.ServiceModel.Channels.ChannelPoolSettings * System.Collections.Generic.IList<System.ServiceModel.Description.ServiceEndpoint> -> System.Workflow.Runtime.Hosting.ChannelManagerService" Usage="new System.Workflow.Runtime.Hosting.ChannelManagerService (settings, endpoints)" />
<MemberSignature Language="C++ CLI" Value="public:
 ChannelManagerService(System::ServiceModel::Channels::ChannelPoolSettings ^ settings, System::Collections::Generic::IList<System::ServiceModel::Description::ServiceEndpoint ^> ^ endpoints);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="settings" Type="System.ServiceModel.Channels.ChannelPoolSettings" />
<Parameter Name="endpoints" Type="System.Collections.Generic.IList<System.ServiceModel.Description.ServiceEndpoint>" />
</Parameters>
<Docs>
<param name="settings">Settings for quotas for the pool of channels managed by this service.</param>
<param name="endpoints">A collection of service endpoints.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Hosting.ChannelManagerService" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates how to create a new instance of the <xref:System.Workflow.Runtime.Hosting.ChannelManagerService> object.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelmanagerservice/cs/snippets.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/channelmanagerservice/vb/snippets.vb" id="Snippet4":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="protected internal override void Start ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void Start() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.Start" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub Start ()" />
<MemberSignature Language="F#" Value="override this.Start : unit -> unit" Usage="channelManagerService.Start " />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void Start();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="protected internal override void Stop ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void Stop() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Hosting.ChannelManagerService.Stop" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub Stop ()" />
<MemberSignature Language="F#" Value="override this.Stop : unit -> unit" Usage="channelManagerService.Stop " />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void Stop();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.WorkflowServices</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>