/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 Server Side 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/db/record_id.h"

namespace mongo {

class OperationContext;
class RecordData;

/**
 * When a capped collection is modified (delete/insert/etc) then certain notifications need to
 * be made, which this (pure virtual) interface exposes.
 */
class CappedCallback {
public:
    virtual ~CappedCallback() {}

    /**
     * This will be called right before loc is deleted when wrapping.
     * If data is unowned, it is only valid inside of this call. If implementations wish to
     * stash a pointer, they must copy it.
     */
    virtual Status aboutToDeleteCapped(OperationContext* opCtx,
                                       const RecordId& loc,
                                       RecordData data) = 0;

    /**
     * Returns true if there may be waiters.
     */
    virtual bool haveCappedWaiters() const = 0;

    /**
     * Used to notify any waiters when new documents may be visible in the capped collection.
     */
    virtual void notifyCappedWaitersIfNeeded() const = 0;
};
}  // namespace mongo