SearchCancellation.h

Go to the documentation of this file.

// Copyright (c) 2009-2014 Alan Wright. All rights reserved.
// Distributable under the terms of either the Apache License (Version 2.0)
// or the GNU Lesser General Public License.
//
// Extended by UnionTech Software Technology Co., Ltd. (2024)
// Added search cancellation support for responsive user interactions

#ifndef SEARCHCANCELLATION_H
#define SEARCHCANCELLATION_H

#include "LuceneTypes.h"
#include <atomic>

namespace Lucene {

class LPPAPI SearchCancellation {
public:
    static void setFlag(std::atomic<bool>* flag);

    static std::atomic<bool>* getFlag();

    static void clear();

    static bool shouldCancel();
};

class LPPAPI SearchCancellationGuard {
public:
    explicit SearchCancellationGuard(std::atomic<bool>* flag);
    ~SearchCancellationGuard();

    // Non-copyable and non-movable
    SearchCancellationGuard(const SearchCancellationGuard&) = delete;
    SearchCancellationGuard& operator=(const SearchCancellationGuard&) = delete;
    SearchCancellationGuard(SearchCancellationGuard&&) = delete;
    SearchCancellationGuard& operator=(SearchCancellationGuard&&) = delete;
};

}

#endif // SEARCHCANCELLATION_H