/
SendMessageChannelCache.xml
276 lines (254 loc) · 20.2 KB
/
SendMessageChannelCache.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
<Type Name="SendMessageChannelCache" FullName="System.ServiceModel.Activities.SendMessageChannelCache">
<TypeSignature Language="C#" Value="public sealed class SendMessageChannelCache : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SendMessageChannelCache extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Activities.SendMessageChannelCache" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SendMessageChannelCache
Implements IDisposable" />
<TypeSignature Language="F#" Value="type SendMessageChannelCache = class
 interface IDisposable" />
<TypeSignature Language="C++ CLI" Value="public ref class SendMessageChannelCache sealed : IDisposable" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Represents an extension that enables the customization of the cache sharing levels, the settings of the channel factory cache, and the settings of the channel cache for workflows that send messages to service endpoints using <see cref="T:System.ServiceModel.Activities.Send" /> messaging activities.</summary>
<remarks>
<format type="text/markdown"><.
## Examples
The following example shows how to use the <xref:System.ServiceModel.Activities.SendMessageChannelCache> class to share a channel cache between two workflow applications in a single app domain.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelcache/cs/client.cs" id="Snippet0":::
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.ServiceModel.Activities.SendMessageChannelCache" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendMessageChannelCache ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.SendMessageChannelCache.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SendMessageChannelCache();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.ServiceModel.Activities.SendMessageChannelCache" /> class with default factory cache and channel cache settings.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendMessageChannelCache (System.ServiceModel.Activities.ChannelCacheSettings factorySettings, System.ServiceModel.Activities.ChannelCacheSettings channelSettings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.Activities.ChannelCacheSettings factorySettings, class System.ServiceModel.Activities.ChannelCacheSettings channelSettings) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.SendMessageChannelCache.#ctor(System.ServiceModel.Activities.ChannelCacheSettings,System.ServiceModel.Activities.ChannelCacheSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (factorySettings As ChannelCacheSettings, channelSettings As ChannelCacheSettings)" />
<MemberSignature Language="F#" Value="new System.ServiceModel.Activities.SendMessageChannelCache : System.ServiceModel.Activities.ChannelCacheSettings * System.ServiceModel.Activities.ChannelCacheSettings -> System.ServiceModel.Activities.SendMessageChannelCache" Usage="new System.ServiceModel.Activities.SendMessageChannelCache (factorySettings, channelSettings)" />
<MemberSignature Language="C++ CLI" Value="public:
 SendMessageChannelCache(System::ServiceModel::Activities::ChannelCacheSettings ^ factorySettings, System::ServiceModel::Activities::ChannelCacheSettings ^ channelSettings);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="factorySettings" Type="System.ServiceModel.Activities.ChannelCacheSettings" />
<Parameter Name="channelSettings" Type="System.ServiceModel.Activities.ChannelCacheSettings" />
</Parameters>
<Docs>
<param name="factorySettings">The cache settings for cached channel factories.</param>
<param name="channelSettings">The cache settings for cached channels.</param>
<summary>Initializes a new instance of the <see cref="T:System.ServiceModel.Activities.SendMessageChannelCache" /> class with custom factory cache and channel cache settings.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For more information about channel factories, see <xref:System.ServiceModel.ChannelFactory> and <xref:System.ServiceModel.ChannelFactory%601>.
You can choose to use only the channel factory cache and disable the channel cache by passing the `channelSettings` parameter to this constructor initialized to a <xref:System.ServiceModel.Activities.ChannelCacheSettings> instance with a <xref:System.ServiceModel.Activities.ChannelCacheSettings.MaxItemsInCache%2A> value of 0. To disable the cache completely for both the channel factory cache and the channel cache, pass the `factorySettings` parameter to this constructor initialized to a <xref:System.ServiceModel.Activities.ChannelCacheSettings> instance with a <xref:System.ServiceModel.Activities.ChannelCacheSettings.MaxItemsInCache%2A> value of 0. Note that you cannot turn the channel cache on if the channel factory cache is disabled.
## Examples
The following example shows how to use the <xref:System.ServiceModel.Activities.SendMessageChannelCache> class to share a channel cache between two workflow applications in a single app domain.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelcache/cs/client.cs" id="Snippet0":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendMessageChannelCache (System.ServiceModel.Activities.ChannelCacheSettings factorySettings, System.ServiceModel.Activities.ChannelCacheSettings channelSettings, bool allowUnsafeCaching);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.Activities.ChannelCacheSettings factorySettings, class System.ServiceModel.Activities.ChannelCacheSettings channelSettings, bool allowUnsafeCaching) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.SendMessageChannelCache.#ctor(System.ServiceModel.Activities.ChannelCacheSettings,System.ServiceModel.Activities.ChannelCacheSettings,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (factorySettings As ChannelCacheSettings, channelSettings As ChannelCacheSettings, allowUnsafeCaching As Boolean)" />
<MemberSignature Language="F#" Value="new System.ServiceModel.Activities.SendMessageChannelCache : System.ServiceModel.Activities.ChannelCacheSettings * System.ServiceModel.Activities.ChannelCacheSettings * bool -> System.ServiceModel.Activities.SendMessageChannelCache" Usage="new System.ServiceModel.Activities.SendMessageChannelCache (factorySettings, channelSettings, allowUnsafeCaching)" />
<MemberSignature Language="C++ CLI" Value="public:
 SendMessageChannelCache(System::ServiceModel::Activities::ChannelCacheSettings ^ factorySettings, System::ServiceModel::Activities::ChannelCacheSettings ^ channelSettings, bool allowUnsafeCaching);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="factorySettings" Type="System.ServiceModel.Activities.ChannelCacheSettings" />
<Parameter Name="channelSettings" Type="System.ServiceModel.Activities.ChannelCacheSettings" />
<Parameter Name="allowUnsafeCaching" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="factorySettings">The cache settings for cached channel factories.</param>
<param name="channelSettings">The cache settings for cached channels.</param>
<param name="allowUnsafeCaching">
<see langword="true" /> to turn caching on; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.ServiceModel.Activities.SendMessageChannelCache" /> class with custom factory cache settings, custom channel cache settings, and a value that indicates whether to turn caching on.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
By default, the cache is only available for <xref:System.ServiceModel.Activities.Send> activities that don't use endpoints defined in configuration. However, if you want to turn caching on in this case call this constructor with the `allowUnsafeCaching` parameter set to `true`. Next, add the new instance of this class as an extension to a workflow service host or a workflow instance.
For more information about channel factories, see <xref:System.ServiceModel.ChannelFactory> and <xref:System.ServiceModel.ChannelFactory%601>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AllowUnsafeCaching">
<MemberSignature Language="C#" Value="public bool AllowUnsafeCaching { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowUnsafeCaching" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Activities.SendMessageChannelCache.AllowUnsafeCaching" />
<MemberSignature Language="VB.NET" Value="Public Property AllowUnsafeCaching As Boolean" />
<MemberSignature Language="F#" Value="member this.AllowUnsafeCaching : bool with get, set" Usage="System.ServiceModel.Activities.SendMessageChannelCache.AllowUnsafeCaching" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AllowUnsafeCaching { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether to turn caching on.</summary>
<value>
<see langword="true" /> to turn caching on; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the <xref:System.ServiceModel.Activities.Send> activity in your workflow has endpoints defined in configuration caching could be unsecure and therefore is disabled by default. However, if you want to turn caching on set this property to `true`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ChannelSettings">
<MemberSignature Language="C#" Value="public System.ServiceModel.Activities.ChannelCacheSettings ChannelSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Activities.ChannelCacheSettings ChannelSettings" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Activities.SendMessageChannelCache.ChannelSettings" />
<MemberSignature Language="VB.NET" Value="Public Property ChannelSettings As ChannelCacheSettings" />
<MemberSignature Language="F#" Value="member this.ChannelSettings : System.ServiceModel.Activities.ChannelCacheSettings with get, set" Usage="System.ServiceModel.Activities.SendMessageChannelCache.ChannelSettings" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::Activities::ChannelCacheSettings ^ ChannelSettings { System::ServiceModel::Activities::ChannelCacheSettings ^ get(); void set(System::ServiceModel::Activities::ChannelCacheSettings ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.ServiceModel.Activities.ChannelCacheSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the settings of the channel cache.</summary>
<value>The settings of the channel cache.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.SendMessageChannelCache.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="sendMessageChannelCache.Dispose " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Dispose();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases all resources used by the current instance of the <see cref="T:System.ServiceModel.Activities.SendMessageChannelCache" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FactorySettings">
<MemberSignature Language="C#" Value="public System.ServiceModel.Activities.ChannelCacheSettings FactorySettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Activities.ChannelCacheSettings FactorySettings" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Activities.SendMessageChannelCache.FactorySettings" />
<MemberSignature Language="VB.NET" Value="Public Property FactorySettings As ChannelCacheSettings" />
<MemberSignature Language="F#" Value="member this.FactorySettings : System.ServiceModel.Activities.ChannelCacheSettings with get, set" Usage="System.ServiceModel.Activities.SendMessageChannelCache.FactorySettings" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::Activities::ChannelCacheSettings ^ FactorySettings { System::ServiceModel::Activities::ChannelCacheSettings ^ get(); void set(System::ServiceModel::Activities::ChannelCacheSettings ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.ServiceModel.Activities.ChannelCacheSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the settings of the channel factory cache.</summary>
<value>The settings of the channel factory cache.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The channel factory cache represents cached channel factories. For more information about channel factories, see <xref:System.ServiceModel.ChannelFactory> and <xref:System.ServiceModel.ChannelFactory%601>.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>