blob: 43ad7500ac840daabf47843e1dea630cc09f7fff (
plain)
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
|
/**
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
namespace mongo {
/**
* A runner runs a query.
*/
class Runner {
public:
virtual ~Runner() { }
/**
* Get the next result from the query.
*/
virtual bool getNext(BSONObj* objOut) = 0;
/**
* Inform the runner that the provided DiskLoc is about to disappear (or change entirely).
* The runner then takes any actions required to continue operating correctly, including
* broadcasting the invalidation request to the PlanStage tree being run.
*
* Called from ClientCursor::aboutToDelete.
*/
virtual void invalidate(const DiskLoc& dl) = 0;
/**
* TODO: Kill these once yielding is controlled inside of a runner.
*/
virtual void yield() = 0;
virtual void unYield() = 0;
};
} // namespace mongo
|
