-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Clerk.xml
318 lines (296 loc) · 18.8 KB
/
Clerk.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
<Type Name="Clerk" FullName="System.EnterpriseServices.CompensatingResourceManager.Clerk">
<TypeSignature Language="C#" Value="public sealed class Clerk" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Clerk extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.EnterpriseServices.CompensatingResourceManager.Clerk" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class Clerk" />
<TypeSignature Language="F#" Value="type Clerk = class" />
<TypeSignature Language="C++ CLI" Value="public ref class Clerk sealed" />
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Writes records of transactional actions to a log.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Each clerk is associated with a compensator, which is called back to perform actions during the two-phase commit of the transaction.
## Examples
The following code example demonstrates the use of this class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Crm/cpp/crmserver.cpp" id="Snippet10":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/ContextUtil/SetAbort/crmserver.cs" id="Snippet10":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Crm/VB/crmserver.vb" id="Snippet10":::
The following code example demonstrates the corresponding <xref:System.EnterpriseServices.CompensatingResourceManager.Compensator> class.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Crm/cpp/crmclient.cpp" id="Snippet30":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/ContextUtil/SetAbort/crmclient.cs" id="Snippet30":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Crm/VB/crmclient.vb" id="Snippet30":::
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.EnterpriseServices.CompensatingResourceManager.Clerk" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Clerk (string compensator, string description, System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions flags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string compensator, string description, valuetype System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions flags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.#ctor(System.String,System.String,System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (compensator As String, description As String, flags As CompensatorOptions)" />
<MemberSignature Language="F#" Value="new System.EnterpriseServices.CompensatingResourceManager.Clerk : string * string * System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions -> System.EnterpriseServices.CompensatingResourceManager.Clerk" Usage="new System.EnterpriseServices.CompensatingResourceManager.Clerk (compensator, description, flags)" />
<MemberSignature Language="C++ CLI" Value="public:
 Clerk(System::String ^ compensator, System::String ^ description, System::EnterpriseServices::CompensatingResourceManager::CompensatorOptions flags);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="compensator" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="flags" Type="System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions" />
</Parameters>
<Docs>
<param name="compensator">The name of the compensator.</param>
<param name="description">The description of the compensator.</param>
<param name="flags">A bitwise combination of the <see cref="T:System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions" /> values.</param>
<summary>Initializes a new instance of the <see cref="T:System.EnterpriseServices.CompensatingResourceManager.Clerk" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Clerk (Type compensator, string description, System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions flags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type compensator, string description, valuetype System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions flags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.#ctor(System.Type,System.String,System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (compensator As Type, description As String, flags As CompensatorOptions)" />
<MemberSignature Language="F#" Value="new System.EnterpriseServices.CompensatingResourceManager.Clerk : Type * string * System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions -> System.EnterpriseServices.CompensatingResourceManager.Clerk" Usage="new System.EnterpriseServices.CompensatingResourceManager.Clerk (compensator, description, flags)" />
<MemberSignature Language="C++ CLI" Value="public:
 Clerk(Type ^ compensator, System::String ^ description, System::EnterpriseServices::CompensatingResourceManager::CompensatorOptions flags);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="compensator" Type="System.Type" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="flags" Type="System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions" />
</Parameters>
<Docs>
<param name="compensator">A type that represents the compensator.</param>
<param name="description">The description of the compensator.</param>
<param name="flags">A bitwise combination of the <see cref="T:System.EnterpriseServices.CompensatingResourceManager.CompensatorOptions" /> values.</param>
<summary>Initializes a new instance of the <see cref="T:System.EnterpriseServices.CompensatingResourceManager.Clerk" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this constructor.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Crm/cpp/crmserver.cpp" id="Snippet11":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/ContextUtil/SetAbort/crmserver.cs" id="Snippet11":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Crm/VB/crmserver.vb" id="Snippet11":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~Clerk ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.Finalize" />
<MemberSignature Language="VB.NET" Value="Finalize ()" />
<MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="clerk.Finalize " />
<MemberSignature Language="C++ CLI" Value="!Clerk ()" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Frees the resources of the current Clerk before it is reclaimed by the garbage collector.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForceLog">
<MemberSignature Language="C#" Value="public void ForceLog ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ForceLog() cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.ForceLog" />
<MemberSignature Language="VB.NET" Value="Public Sub ForceLog ()" />
<MemberSignature Language="F#" Value="member this.ForceLog : unit -> unit" Usage="clerk.ForceLog " />
<MemberSignature Language="C++ CLI" Value="public:
 void ForceLog();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Forces all log records to disk.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The Compensating Resource Manager (CRM) Worker and CRM Compensator use this method to write records lazily to the log, which means they are not made durable until they have been forced to the log. Calling <xref:System.EnterpriseServices.CompensatingResourceManager.Clerk.ForceLog%2A> makes all log records that have been written durable on disk.
## Examples
The following code example demonstrates the use of this method.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Crm/cpp/crmserver.cpp" id="Snippet12":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/ContextUtil/SetAbort/crmserver.cs" id="Snippet12":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Crm/VB/crmserver.vb" id="Snippet12":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ForceTransactionToAbort">
<MemberSignature Language="C#" Value="public void ForceTransactionToAbort ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ForceTransactionToAbort() cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.ForceTransactionToAbort" />
<MemberSignature Language="VB.NET" Value="Public Sub ForceTransactionToAbort ()" />
<MemberSignature Language="F#" Value="member this.ForceTransactionToAbort : unit -> unit" Usage="clerk.ForceTransactionToAbort " />
<MemberSignature Language="C++ CLI" Value="public:
 void ForceTransactionToAbort();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Performs an immediate abort call on the transaction.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForgetLogRecord">
<MemberSignature Language="C#" Value="public void ForgetLogRecord ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ForgetLogRecord() cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.ForgetLogRecord" />
<MemberSignature Language="VB.NET" Value="Public Sub ForgetLogRecord ()" />
<MemberSignature Language="F#" Value="member this.ForgetLogRecord : unit -> unit" Usage="clerk.ForgetLogRecord " />
<MemberSignature Language="C++ CLI" Value="public:
 void ForgetLogRecord();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Does not deliver the last log record that was written by this instance of this interface.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This can only be used to forget the last record, there is no concept of nesting; that is, "Write, Forget, Write, Forget" is valid, but "Write, Write, Forget, Forget" is not. A log record that has been forgotten is not delivered to the Compensating Resource Manager (CRM) Compensator during transaction outcome notifications.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="LogRecordCount">
<MemberSignature Language="C#" Value="public int LogRecordCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 LogRecordCount" />
<MemberSignature Language="DocId" Value="P:System.EnterpriseServices.CompensatingResourceManager.Clerk.LogRecordCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LogRecordCount As Integer" />
<MemberSignature Language="F#" Value="member this.LogRecordCount : int" Usage="System.EnterpriseServices.CompensatingResourceManager.Clerk.LogRecordCount" />
<MemberSignature Language="C++ CLI" Value="public:
 property int LogRecordCount { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of log records.</summary>
<value>The number of log records.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TransactionUOW">
<MemberSignature Language="C#" Value="public string TransactionUOW { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TransactionUOW" />
<MemberSignature Language="DocId" Value="P:System.EnterpriseServices.CompensatingResourceManager.Clerk.TransactionUOW" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TransactionUOW As String" />
<MemberSignature Language="F#" Value="member this.TransactionUOW : string" Usage="System.EnterpriseServices.CompensatingResourceManager.Clerk.TransactionUOW" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TransactionUOW { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value representing the transaction unit of work (UOW).</summary>
<value>A GUID representing the UOW.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteLogRecord">
<MemberSignature Language="C#" Value="public void WriteLogRecord (object record);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteLogRecord(object record) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.CompensatingResourceManager.Clerk.WriteLogRecord(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteLogRecord (record As Object)" />
<MemberSignature Language="F#" Value="member this.WriteLogRecord : obj -> unit" Usage="clerk.WriteLogRecord record" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteLogRecord(System::Object ^ record);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="record" Type="System.Object" />
</Parameters>
<Docs>
<param name="record">The log record to write to the log.</param>
<summary>Writes unstructured log records to the log.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this constructor.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Crm/cpp/crmserver.cpp" id="Snippet11":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/ContextUtil/SetAbort/crmserver.cs" id="Snippet11":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Crm/VB/crmserver.vb" id="Snippet11":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>