52 lines
1.3 KiB
C++
52 lines
1.3 KiB
C++
/**
|
|
* @file include/ActivOneApi/Constants/QueryStates.h
|
|
*
|
|
* @brief Header for the QueryState definitions.
|
|
*/
|
|
|
|
#if (!defined ACTIV_ONE_API_CONSTANTS_QUERY_STATES_H)
|
|
#define ACTIV_ONE_API_CONSTANTS_QUERY_STATES_H
|
|
|
|
#include "ActivOneApi/External.h"
|
|
|
|
#include "ActivOneApi/TypeDefinitions.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
//! OneApi namespace.
|
|
namespace OneApi
|
|
{
|
|
|
|
// QueryState values.
|
|
|
|
//! The query is pending, results for currently available topics will be delivered.
|
|
const QueryState QUERY_STATE_PENDING = 0;
|
|
|
|
//! Initial search has been completed. The query will still be watching for changes.
|
|
const QueryState QUERY_STATE_COMPLETE = 1;
|
|
|
|
//! Query error, the query will be automatically retried.
|
|
const QueryState QUERY_STATE_ERROR = 2;
|
|
|
|
//! The query has failed and will not recover.
|
|
const QueryState QUERY_STATE_FAILURE = 3;
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Convert a QueryState to a string.
|
|
*
|
|
* @param queryState
|
|
*
|
|
* @return String representation of @a queryState.
|
|
*/
|
|
ACTIV_ONE_API String QueryStateToString(const QueryState queryState);
|
|
|
|
} // namespace OneApi
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_ONE_API_CONSTANTS_QUERY_STATES_H)
|