/
IAtomicGroupStateReplicator.xml
172 lines (172 loc) · 12.2 KB
/
IAtomicGroupStateReplicator.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
<Type Name="IAtomicGroupStateReplicator" FullName="System.Fabric.IAtomicGroupStateReplicator">
<TypeSignature Language="C#" Value="public interface IAtomicGroupStateReplicator" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IAtomicGroupStateReplicator" />
<TypeSignature Language="DocId" Value="T:System.Fabric.IAtomicGroupStateReplicator" />
<TypeSignature Language="VB.NET" Value="Public Interface IAtomicGroupStateReplicator" />
<TypeSignature Language="F#" Value="type IAtomicGroupStateReplicator = interface" />
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
<para>Exposes replication-related functions for atomic groups. </para>
</summary>
<remarks>
<para>The <see cref="T:System.Fabric.IAtomicGroupStateReplicator" /> is available if the service is a member of a service group. The service must implement <see cref="T:System.Fabric.IAtomicGroupStateProvider" /> and be stateful. When creating a <see cref="T:System.Fabric.FabricReplicator" /> via <see cref="M:System.Fabric.IStatefulServicePartition.CreateReplicator(System.Fabric.IStateProvider,System.Fabric.ReplicatorSettings)" />, instead of passing in a regular <see cref="T:System.Fabric.IStateProvider" />, the service can pass in the <see cref="T:System.Fabric.IAtomicGroupStateProvider" /> that it implements instead. As a result, it receives a <see cref="T:System.Fabric.IAtomicGroupStateReplicator" />.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="CreateAtomicGroup">
<MemberSignature Language="C#" Value="public long CreateAtomicGroup ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int64 CreateAtomicGroup() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.IAtomicGroupStateReplicator.CreateAtomicGroup" />
<MemberSignature Language="VB.NET" Value="Public Function CreateAtomicGroup () As Long" />
<MemberSignature Language="F#" Value="abstract member CreateAtomicGroup : unit -> int64" Usage="iAtomicGroupStateReplicator.CreateAtomicGroup " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Creates a new atomic group and obtains the ID of the atomic group.</para>
</summary>
<returns>
<para>Returns <see cref="T:System.Int64" /> the ID of the created atomic group.</para>
</returns>
<remarks>
<para>Atomic groups are used to coordinate a set of changes across the members of a service group.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ReplicateAtomicGroupCommitAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<long> ReplicateAtomicGroupCommitAsync (long atomicGroupId, System.Threading.CancellationToken cancellationToken, out long commitSequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int64> ReplicateAtomicGroupCommitAsync(int64 atomicGroupId, valuetype System.Threading.CancellationToken cancellationToken, [out] int64& commitSequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.IAtomicGroupStateReplicator.ReplicateAtomicGroupCommitAsync(System.Int64,System.Threading.CancellationToken,System.Int64@)" />
<MemberSignature Language="VB.NET" Value="Public Function ReplicateAtomicGroupCommitAsync (atomicGroupId As Long, cancellationToken As CancellationToken, ByRef commitSequenceNumber As Long) As Task(Of Long)" />
<MemberSignature Language="F#" Value="abstract member ReplicateAtomicGroupCommitAsync : int64 * System.Threading.CancellationToken * int64 -> System.Threading.Tasks.Task<int64>" Usage="iAtomicGroupStateReplicator.ReplicateAtomicGroupCommitAsync (atomicGroupId, cancellationToken, commitSequenceNumber)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int64></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="atomicGroupId" Type="System.Int64" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
<Parameter Name="commitSequenceNumber" Type="System.Int64" RefType="out" />
</Parameters>
<Docs>
<param name="atomicGroupId">
<para>The ID of the group to be committed.</para>
</param>
<param name="cancellationToken">
<para>The <see cref="T:System.Threading.CancellationToken" /> object that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation might still be completed even if it is canceled.</para>
</param>
<param name="commitSequenceNumber">
<para>The LSN of the commit operation, as an out parameter.</para>
</param>
<summary>
<para>Asynchronously commits state replication for the atomic group.</para>
</summary>
<returns>
<para>Returns <see cref="T:System.Threading.Tasks.Task`1" /> of type long, the LSN of the commit operation.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReplicateAtomicGroupOperationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<long> ReplicateAtomicGroupOperationAsync (long atomicGroupId, System.Fabric.OperationData operationData, System.Threading.CancellationToken cancellationToken, out long sequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int64> ReplicateAtomicGroupOperationAsync(int64 atomicGroupId, class System.Fabric.OperationData operationData, valuetype System.Threading.CancellationToken cancellationToken, [out] int64& sequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.IAtomicGroupStateReplicator.ReplicateAtomicGroupOperationAsync(System.Int64,System.Fabric.OperationData,System.Threading.CancellationToken,System.Int64@)" />
<MemberSignature Language="VB.NET" Value="Public Function ReplicateAtomicGroupOperationAsync (atomicGroupId As Long, operationData As OperationData, cancellationToken As CancellationToken, ByRef sequenceNumber As Long) As Task(Of Long)" />
<MemberSignature Language="F#" Value="abstract member ReplicateAtomicGroupOperationAsync : int64 * System.Fabric.OperationData * System.Threading.CancellationToken * int64 -> System.Threading.Tasks.Task<int64>" Usage="iAtomicGroupStateReplicator.ReplicateAtomicGroupOperationAsync (atomicGroupId, operationData, cancellationToken, sequenceNumber)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int64></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="atomicGroupId" Type="System.Int64" />
<Parameter Name="operationData" Type="System.Fabric.OperationData" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
<Parameter Name="sequenceNumber" Type="System.Int64" RefType="out" />
</Parameters>
<Docs>
<param name="atomicGroupId">
<para>The ID of the atomic group that is obtained from <see cref="M:System.Fabric.IAtomicGroupStateReplicator.CreateAtomicGroup" /> and includes the <see cref="T:System.Fabric.OperationData" />.</para>
</param>
<param name="operationData">
<para>An <see cref="T:System.Fabric.OperationData" /> to be replicated.</para>
</param>
<param name="cancellationToken">
<para>The CancellationToken object that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation might still be completed even if it is canceled.</para>
</param>
<param name="sequenceNumber">
<para>The LSN of the operation, as an out parameter.</para>
</param>
<summary>
<para>Replicates some <see cref="T:System.Fabric.OperationData" /> as a part of an atomic group.</para>
</summary>
<returns>
<para>Returns <see cref="T:System.Threading.Tasks.Task`1" /> of type long, the LSN of the replicated atomic group operation.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReplicateAtomicGroupRollbackAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<long> ReplicateAtomicGroupRollbackAsync (long atomicGroupId, System.Threading.CancellationToken cancellationToken, out long rollbackSequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int64> ReplicateAtomicGroupRollbackAsync(int64 atomicGroupId, valuetype System.Threading.CancellationToken cancellationToken, [out] int64& rollbackSequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.IAtomicGroupStateReplicator.ReplicateAtomicGroupRollbackAsync(System.Int64,System.Threading.CancellationToken,System.Int64@)" />
<MemberSignature Language="VB.NET" Value="Public Function ReplicateAtomicGroupRollbackAsync (atomicGroupId As Long, cancellationToken As CancellationToken, ByRef rollbackSequenceNumber As Long) As Task(Of Long)" />
<MemberSignature Language="F#" Value="abstract member ReplicateAtomicGroupRollbackAsync : int64 * System.Threading.CancellationToken * int64 -> System.Threading.Tasks.Task<int64>" Usage="iAtomicGroupStateReplicator.ReplicateAtomicGroupRollbackAsync (atomicGroupId, cancellationToken, rollbackSequenceNumber)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int64></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="atomicGroupId" Type="System.Int64" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
<Parameter Name="rollbackSequenceNumber" Type="System.Int64" RefType="out" />
</Parameters>
<Docs>
<param name="atomicGroupId">
<para>The ID of the atomic group to roll back.</para>
</param>
<param name="cancellationToken">
<para>The <see cref="T:System.Threading.CancellationToken" /> object that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation might still be completed even if it is canceled.</para>
</param>
<param name="rollbackSequenceNumber">
<para>The LSN of the rollback operation, as an out parameter.</para>
</param>
<summary>
<para>Asynchronously rolls-back state replication for the atomic group.</para>
</summary>
<returns>
<para>Returns <see cref="T:System.Threading.Tasks.Task`1" /> of type long, the LSN of the rollback operation.</para>
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>