mirror of
https://github.com/mongodb/mongo.git
synced 2024-11-30 09:06:21 +01:00
94 lines
2.8 KiB
C++
94 lines
2.8 KiB
C++
// 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
|
|
|
|
namespace mongo {
|
|
|
|
/** object-orienty background thread dispatching.
|
|
|
|
subclass and define run()
|
|
|
|
It is ok to call go(), that is, run the job, more than once -- if the
|
|
previous invocation has finished. Thus one pattern of use is to embed
|
|
a backgroundjob in your object and reuse it (or same thing with
|
|
inheritance). Each go() call spawns a new thread.
|
|
|
|
note when job destructs, the thread is not terminated if still running.
|
|
generally if the thread could still be running, allocate the job dynamically
|
|
and set deleteSelf to true.
|
|
*/
|
|
/* example
|
|
class ConnectBG : public BackgroundJob {
|
|
public:
|
|
int sock;
|
|
int res;
|
|
SockAddr farEnd;
|
|
void run() {
|
|
res = ::connect(sock, farEnd.raw(), farEnd.addressSize);
|
|
}
|
|
};
|
|
*/
|
|
class BackgroundJob : boost::noncopyable {
|
|
protected:
|
|
/** define this to do your work.
|
|
after this returns, state is set to done.
|
|
after this returns, deleted if deleteSelf true.
|
|
*/
|
|
virtual void run() = 0;
|
|
|
|
public:
|
|
enum State {
|
|
NotStarted,
|
|
Running,
|
|
Done
|
|
};
|
|
State getState() const { return state; }
|
|
bool running() const { return state == Running; }
|
|
|
|
bool deleteSelf; // delete self when Done?
|
|
|
|
BackgroundJob() {
|
|
deleteSelf = false;
|
|
state = NotStarted;
|
|
}
|
|
virtual ~BackgroundJob() { }
|
|
|
|
// starts job. returns once it is "dispatched"
|
|
BackgroundJob& go();
|
|
|
|
// wait for completion. this spins with sleep() so not terribly efficient.
|
|
// returns true if did not time out.
|
|
//
|
|
// note you can call wait() more than once if the first call times out.
|
|
bool wait(int msMax = 0, unsigned maxSleepInterval=1000);
|
|
|
|
/* start several */
|
|
static void go(list<BackgroundJob*>&);
|
|
|
|
/* wait for several jobs to finish. */
|
|
static void wait(list<BackgroundJob*>&, unsigned maxSleepInterval=1000);
|
|
|
|
private:
|
|
static BackgroundJob *grab;
|
|
static mongo::mutex mutex;
|
|
static void thr();
|
|
volatile State state;
|
|
};
|
|
|
|
} // namespace mongo
|