NCBI C++ ToolKit
icanceled.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef UTIL_ICANCELED__HPP
2 #define UTIL_ICANCELED__HPP
3 
4 /* $Id: icanceled.hpp 52332 2011-12-16 20:30:27Z lavr $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Eugene Vasilchenko
30  *
31  * File Description:
32  * ICanceled -
33  * Interface for testing cancellation request in a long lasting operation.
34  *
35  */
36 
37 #include <corelib/ncbistd.hpp>
38 
40 
41 
42 /** @addtogroup StreamSupport
43  *
44  * @{
45  */
46 
47 
48 /// Interface for testing cancellation request in a long lasting operation.
49 /// The implementation must have CObject as its first parent.
50 class ICanceled
51 {
52 public:
53  virtual bool IsCanceled(void) const = 0;
54  virtual ~ICanceled() {}
55 };
56 
57 
58 /* @} */
59 
60 
62 
63 #endif // UTIL_ICANCELED__HPP
Interface for testing cancellation request in a long lasting operation.
Definition: icanceled.hpp:51
Include a standard set of the NCBI C++ Toolkit most basic headers.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
virtual bool IsCanceled(void) const =0
virtual ~ICanceled()
Definition: icanceled.hpp:54
Modified on Wed Apr 17 13:08:36 2024 by modify_doxy.py rev. 669887