/**
* Copyright (C) 2016 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 .
*
* 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
#include
#include
#include "mongo/base/disallow_copying.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/util/time_support.h"
namespace mongo {
class OperationContext;
namespace repl {
/**
* Interface for temporary container of oplog entries (in BSON format) from sync source by
* OplogFetcher that will be read by applier in the DataReplicator.
*
* Implementations are only required to support one pusher and one popper.
*/
class OplogBuffer {
MONGO_DISALLOW_COPYING(OplogBuffer);
public:
/**
* Type of item held in the oplog buffer;
*/
using Value = BSONObj;
/**
* Batch of oplog entries (in BSON format) for bulk read/write operations.
*/
using Batch = std::vector;
OplogBuffer() = default;
virtual ~OplogBuffer() = default;
/**
* Causes the oplog buffer to initialize its internal state (start threads if appropriate,
* create backing storage, etc). This method may be called at most once for the lifetime of an
* oplog buffer.
*/
virtual void startup(OperationContext* txn) = 0;
/**
* Signals to the oplog buffer that it should shut down. This method may block. After
* calling shutdown, it is illegal to perform read/write operations on this oplog buffer.
*
* It is legal to call this method multiple times, but it should only be called after startup
* has been called.
*/
virtual void shutdown(OperationContext* txn) = 0;
/**
* Pushes operation into oplog buffer, ignoring any size constraints. Does not block.
* If the oplog buffer is already full, this will cause the size of the oplog buffer to exceed
* the limit returned by getMaxSize() but should not otherwise adversely affect normal
* functionality such as pushing and popping operations from the oplog buffer.
*/
virtual void pushEvenIfFull(OperationContext* txn, const Value& value) = 0;
/**
* Pushes operation into oplog buffer.
* If there are size constraints on the oplog buffer, this may block until sufficient space
* is made available (by popping) to complete this operation.
*/
virtual void push(OperationContext* txn, const Value& value) = 0;
/**
* Pushes operations in the iterator range [begin, end) into the oplog buffer without blocking.
*/
virtual void pushAllNonBlocking(OperationContext* txn,
Batch::const_iterator begin,
Batch::const_iterator end) = 0;
/**
* Returns when enough space is available.
*/
virtual void waitForSpace(OperationContext* txn, std::size_t size) = 0;
/**
* Returns true if oplog buffer is empty.
*/
virtual bool isEmpty() const = 0;
/**
* Maximum size of all oplog entries that can be stored in this oplog buffer as measured by the
* BSONObj::objsize() function.
*
* Returns 0 if this oplog buffer has no size constraints.
*/
virtual std::size_t getMaxSize() const = 0;
/**
* Total size of all oplog entries in this oplog buffer as measured by the BSONObj::objsize()
* function.
*/
virtual std::size_t getSize() const = 0;
/**
* Returns the number/count of items in the oplog buffer.
*/
virtual std::size_t getCount() const = 0;
/**
* Clears oplog buffer.
*/
virtual void clear(OperationContext* txn) = 0;
/**
* Returns false if oplog buffer is empty. "value" is left unchanged.
* Otherwise, removes last item (saves in "value") from the oplog buffer and returns true.
*/
virtual bool tryPop(OperationContext* txn, Value* value) = 0;
/**
* Waits "waitDuration" for an operation to be pushed into the oplog buffer.
* Returns false if oplog buffer is still empty after "waitDuration".
* Otherwise, returns true.
*/
virtual bool waitForData(Seconds waitDuration) = 0;
/**
* Returns false if oplog buffer is empty.
* Otherwise, returns true and sets "value" to last item in oplog buffer.
*/
virtual bool peek(OperationContext* txn, Value* value) = 0;
/**
* Returns the item most recently added to the oplog buffer or nothing if the buffer is empty.
*/
virtual boost::optional lastObjectPushed(OperationContext* txn) const = 0;
};
} // namespace repl
} // namespace mongo