-
Notifications
You must be signed in to change notification settings - Fork 254
/
IOperationDataStream.xml
60 lines (60 loc) · 3.7 KB
/
IOperationDataStream.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
<Type Name="IOperationDataStream" FullName="System.Fabric.IOperationDataStream">
<TypeSignature Language="C#" Value="public interface IOperationDataStream" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IOperationDataStream" />
<TypeSignature Language="DocId" Value="T:System.Fabric.IOperationDataStream" />
<TypeSignature Language="VB.NET" Value="Public Interface IOperationDataStream" />
<TypeSignature Language="F#" Value="type IOperationDataStream = interface" />
<AssemblyInfo>
<AssemblyName>System.Fabric</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
<para> An <see cref="T:System.Fabric.IOperationDataStream" />
encapsulates a stream of <see cref="T:System.Fabric.OperationData" /> objects that are exchanged between Primary replica and Secondary replica.
Objects that implement <see cref="T:System.Fabric.IOperationDataStream" /> are used during the copy process.
Both the copy context <see cref="M:System.Fabric.IStateProvider.GetCopyContext" /> method that is sent from the Secondary replica to the Primary replica
and the copy state <see cref="M:System.Fabric.IStateProvider.GetCopyState(System.Int64,System.Fabric.IOperationDataStream)" /> method implement the <see cref="T:System.Fabric.IOperationDataStream" />
interface.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetNextAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Fabric.OperationData> GetNextAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Fabric.OperationData> GetNextAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Fabric.IOperationDataStream.GetNextAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetNextAsync (cancellationToken As CancellationToken) As Task(Of OperationData)" />
<MemberSignature Language="F#" Value="abstract member GetNextAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.OperationData>" Usage="iOperationDataStream.GetNextAsync cancellationToken" />
<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.Fabric.OperationData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">
<para>Provides a mechanism to cancel the asynchronous operation.</para>
</param>
<summary>
<para>Gets the next <see cref="T:System.Fabric.OperationData" /> object from the <see cref="T:System.Fabric.IOperationDataStream" />.</para>
</summary>
<returns>
<para>Returns <see cref="T:System.Threading.Tasks.Task`1" /> of type <see cref="T:System.Fabric.OperationData" />.</para>
</returns>
<remarks>
<para>
Returning null indicates to the system that the transfer is complete.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>