background.h

// @file background.h
 
/*    Copyright 2009 10gen 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.
 */
 
#pragma once
 
#include <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
#include <string>
#include <vector>
 
#include "mongo/base/status.h"
 
namespace mongo {
 
class BackgroundJob : boost::noncopyable {
protected:
    explicit BackgroundJob(bool selfDelete = false);
 
    virtual std::string name() const = 0;
 
    virtual void run() = 0;
 
public:
    enum State { NotStarted, Running, Done };
 
    virtual ~BackgroundJob();
 
    void go();
 
 
    Status cancel();
 
    bool wait(unsigned msTimeOut = 0);
 
    // accessors. Note that while the access to the internal state is synchronized within
    // these methods, there is no guarantee that the BackgroundJob is still in the
    // indicated state after returning.
    State getState() const;
    bool running() const;
 
private:
    const bool _selfDelete;
 
    struct JobStatus;
    const boost::scoped_ptr<JobStatus> _status;
 
    void jobBody();
};
 
}  // namespace mongo