-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
IBatchableSource.cs
113 lines (101 loc) · 3.23 KB
/
IBatchableSource.cs
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
/* Copyright 2018-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
namespace MongoDB.Driver.Core.Misc
{
/// <summary>
/// Represents a batch of items that can be split if not all items can be processed at once.
/// </summary>
/// <typeparam name="T">The type of the items.</typeparam>
public interface IBatchableSource<out T>
{
// properties
/// <summary>
/// Gets a value indicating whether all items were processed.
/// </summary>
/// <value>
/// <c>true</c> if all items were processed; otherwise, <c>false</c>.
/// </value>
bool AllItemsWereProcessed { get; }
/// <summary>
/// Gets a value indicating whether the batch can be split.
/// </summary>
/// <value>
/// <c>true</c> if the batch can be split; otherwise, <c>false</c>.
/// </value>
bool CanBeSplit { get; }
/// <summary>
/// Gets the count.
/// </summary>
/// <value>
/// The count.
/// </value>
int Count { get; }
/// <summary>
/// Gets the items.
/// </summary>
/// <value>
/// The items.
/// </value>
IReadOnlyList<T> Items { get; }
/// <summary>
/// Gets the offset.
/// </summary>
/// <value>
/// The offset.
/// </value>
int Offset { get; }
/// <summary>
/// Gets the count of processed items. Equal to zero until SetProcessedCount has been called.
/// </summary>
/// <value>
/// The count of processed items.
/// </value>
int ProcessedCount { get; }
// methods
/// <summary>
/// Advances past the processed items.
/// </summary>
void AdvancePastProcessedItems();
/// <summary>
/// Gets the items in the batch.
/// </summary>
/// <returns>
/// The items in the batch.
/// </returns>
IReadOnlyList<T> GetBatchItems();
/// <summary>
/// Gets the items that were processed.
/// </summary>
/// <returns>
/// The items that were processed.
/// </returns>
IReadOnlyList<T> GetProcessedItems();
/// <summary>
/// Gets the items that were not processed.
/// </summary>
/// <returns>
/// The items that were not processed.
/// </returns>
IReadOnlyList<T> GetUnprocessedItems();
/// <summary>
/// Sets the processed count.
/// </summary>
/// <param name="value">The value.</param>
void SetProcessedCount(int value);
}
}