/**
 *    Copyright (C) 2014 MongoDB 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 "mongo/base/disallow_copying.h"
#include "mongo/bson/util/atomic_int.h"

namespace mongo {

    class OperationContext;

    class GlobalEnvironmentExperiment {
        MONGO_DISALLOW_COPYING(GlobalEnvironmentExperiment);
    public:
        virtual ~GlobalEnvironmentExperiment() { }

        //
        // Global operation management.  This may not belong here and there may be too many methods
        // here.
        //

        /**
         * Signal all OperationContext(s) that they have been killed.
         */
        virtual void setKillAllOperations() = 0;

        /**
         * Reset the operation kill state after a killAllOperations.
         * Used for testing.
         */
        virtual void unsetKillAllOperations() = 0;

        /**
         * Get the state for killing all operations.
         */
        virtual bool getKillAllOperations() = 0;

        /**
         * @param i opid of operation to kill
         * @return if operation was found 
         **/
        virtual bool killOperation(AtomicUInt opId) = 0;

        //
        // Factories for storage interfaces
        //

        /**
         * Returns a new OperationContext.  Caller owns pointer.
         */
        virtual OperationContext* newOpCtx() = 0;

    protected:
        GlobalEnvironmentExperiment() { }
    };

    /**
     * Returns the singleton GlobalEnvironmentExperiment for this server process.
     *
     * Caller does not own pointer.
     */
    GlobalEnvironmentExperiment* getGlobalEnvironment();

    /**
     * Sets the GlobalEnvironmentExperiment.  If 'globalEnvironment' is NULL, un-sets and deletes the current
     * GlobalEnvironmentExperiment.
     *
     * Takes ownership of 'globalEnvironment'.
     */
    void setGlobalEnvironment(GlobalEnvironmentExperiment* globalEnvironment);

}  // namespace mongo
