Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions
Lucene::SearchCancellationGuard Class Reference

RAII guard for automatic cancellation flag management. More...

#include <SearchCancellation.h>

Public Member Functions

 SearchCancellationGuard (std::atomic< bool > *flag)
 
 ~SearchCancellationGuard ()
 
 SearchCancellationGuard (const SearchCancellationGuard &)=delete
 
SearchCancellationGuardoperator= (const SearchCancellationGuard &)=delete
 
 SearchCancellationGuard (SearchCancellationGuard &&)=delete
 
SearchCancellationGuardoperator= (SearchCancellationGuard &&)=delete
 

Detailed Description

RAII guard for automatic cancellation flag management.

Usage:

void performSearch() {
SearchCancellationGuard guard(&m_cancelled);
// ... perform search ...
} // Automatic cleanup on scope exit
RAII guard for automatic cancellation flag management.
Definition SearchCancellation.h:71

Constructor & Destructor Documentation

◆ SearchCancellationGuard() [1/3]

Lucene::SearchCancellationGuard::SearchCancellationGuard ( std::atomic< bool > *  flag)
explicit

◆ ~SearchCancellationGuard()

Lucene::SearchCancellationGuard::~SearchCancellationGuard ( )

◆ SearchCancellationGuard() [2/3]

Lucene::SearchCancellationGuard::SearchCancellationGuard ( const SearchCancellationGuard )
delete

◆ SearchCancellationGuard() [3/3]

Lucene::SearchCancellationGuard::SearchCancellationGuard ( SearchCancellationGuard &&  )
delete

Member Function Documentation

◆ operator=() [1/2]

SearchCancellationGuard & Lucene::SearchCancellationGuard::operator= ( const SearchCancellationGuard )
delete

◆ operator=() [2/2]

SearchCancellationGuard & Lucene::SearchCancellationGuard::operator= ( SearchCancellationGuard &&  )
delete

The documentation for this class was generated from the following file:

clucene.sourceforge.net