summaryrefslogtreecommitdiff
path: root/src/mongo/db/periodic_runner_job_abort_expired_transactions.h
blob: 28ab86d1b6448c7a8eab278cd9e752842d589b75 (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
/**
 * Copyright (C) 2018 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

namespace mongo {

class ServiceContext;

/**
 * Defines and starts a periodic background job to check for and abort expired transactions.
 * The job will run every (transactionLifetimeLimitSeconds/2) seconds, or at most once per second
 * and at least once per minute.
 *
 * This function should only ever be called once, during mongod server startup (db.cpp).
 * The PeriodicRunner will handle shutting down the job on shutdown, no extra handling necessary.
 */
void startPeriodicThreadToAbortExpiredTransactions(ServiceContext* serviceContext);

}  // namespace mongo