summaryrefslogtreecommitdiff
path: root/src/mongo/db/structure/collection.h
blob: c5380cf0dd6ee957b80a65f835609167abd6000e (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
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
// collection.h

/**
*    Copyright (C) 2012 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/>.
*
*    As a special exception, the copyright holders give permission to link the
*    code of portions of this program with the OpenSSL library under certain
*    conditions as described in each individual source file and distribute
*    linked combinations including the program with the OpenSSL library. You
*    must comply with the GNU Affero General Public License in all respects for
*    all of the code used other than as permitted herein. If you modify file(s)
*    with this exception, you may extend this exception to your version of the
*    file(s), but you are not obligated to do so. If you do not wish to do so,
*    delete this exception statement from your version. If you delete this
*    exception statement from all source files in the program, then also delete
*    it in the license file.
*/

#pragma once

#include <string>

#include "mongo/base/string_data.h"
#include "mongo/db/diskloc.h"
#include "mongo/db/exec/collection_scan_common.h"

namespace mongo {

    class Database;
    class ExtentManager;
    class NamespaceDetails;

    class CollectionIterator;
    class FlatIterator;
    class CappedIterator;

    /**
     * this is NOT safe through a yield right now
     * not sure if it will be, or what yet
     */
    class CollectionTemp {
    public:
        CollectionTemp( const StringData& fullNS,
                        NamespaceDetails* details,
                        Database* database );

        ~CollectionTemp();

        bool ok() const { return _magic == 1357924; }

        StringData ns() const { return _ns; }

        CollectionIterator* getIterator( const DiskLoc& start, bool tailable,
                                         const CollectionScanParams::Direction& dir) const;

    private:

        ExtentManager* getExtentManager();
        const ExtentManager* getExtentManager() const;

        int _magic;

        std::string _ns;
        NamespaceDetails* _details;
        Database* _database;

        friend class Database;
        friend class FlatIterator;
        friend class CappedIterator;
    };

}