Класс ilg::CAsyncCommand

Класс команды SDK. Подробнее...

#include <ilg_cpp_helpers.h>

Граф наследования:ilg::CAsyncCommand:

Граф связей класса ilg::CAsyncCommand:

Открытые члены
	CAsyncCommand ()
	Конструктор по умолчанию.
	CAsyncCommand (ilg_handle h)
	Конструктор класса из дескриптора команды. Подробнее...
	CAsyncCommand (CAsyncCommand &&other)
	Конструктор перемещения. Подробнее...
virtual	~CAsyncCommand ()
	Деструктор
CAsyncCommand &	operator= (CAsyncCommand &&other)
	Оператор перемещения
void	Cancel ()
	Отменяет команду. Устанавливает статус ILG_E_ABORT. Подробнее...
ilg_status	GetStatus () const
	Возвращает состояние команды. Подробнее...
void	GetProgress (size_t &nCurrent, size_t &nTotal) const
	Возвращает состояние прогресса выполнения команды. Подробнее...
Открытые члены унаследованные от ilg::CILGHandle
	CILGHandle ()
	Конструктор по умолчанию.
	CILGHandle (ilg_handle h)
	Конструктор из дескриптора SDK. Подробнее...
	CILGHandle (const CILGHandle &)=delete
	Запрещаем копирование этого класса (т.к. он содержит указатель = дескриптор).
	CILGHandle (CILGHandle &&other)
	Конструктор перемещения. Подробнее...
virtual	~CILGHandle ()
	Деструктор
CILGHandle &	operator= (const CILGHandle &)=delete
	Запрещаем копирование этого класса (т.к. он содержит указатель = дескриптор).
CILGHandle &	operator= (CILGHandle &&other)
	Оператор перемещения. Подробнее...
	operator ilg_handle () const
	Оператор приведения типа к ilg_handle.
	operator bool () const
	Проверяет дескриптор на валидность.
void	Swap (CILGHandle &other) noexcept
	Обменивается значением с другим дескриптором. Подробнее...
ilg_handle	Get () const
	Возвращает дескриптор SDK.
void	Close ()
	Закрывает дескриптор SDK. Подробнее...
void	Attach (ilg_handle h)
	Присоединяет дескриптор к этому объекту. Подробнее...
ilg_handle	Detach ()
	Отсоединяет дескриптор от этого объекту. Подробнее...

Дополнительные унаследованные члены
Защищенные данные унаследованные от ilg::CILGHandle
ilg_handle	m_h
	Дескриптор SDK.

Подробное описание

Класс команды SDK.

Класс для управления асинхронными запросом.

Конструктор(ы)

CAsyncCommand() [1/2]

ilg::CAsyncCommand::CAsyncCommand

(

ilg_handle

h

)

Конструктор класса из дескриптора команды.

Аргументы

[in]

h

Значение дескриптора SDK.

CAsyncCommand() [2/2]

ilg::CAsyncCommand::CAsyncCommand

(

CAsyncCommand &&

other

)

Конструктор перемещения.

Аргументы

[in,out]

other

Другой дескриптор команды.

Методы

Cancel()

void ilg::CAsyncCommand::Cancel ( )

inline

Отменяет команду. Устанавливает статус ILG_E_ABORT.

Исключения

CILGException(ILG_E_HANDLE)

если дескриптор неправильный.

GetProgress()

void ilg::CAsyncCommand::GetProgress ( size_t &  nCurrent, size_t &  nTotal  ) const

inline

Возвращает состояние прогресса выполнения команды.

Аргументы

[out]	nCurrent	Текущий шаг.
[out]	nTotal	Всего шагов.

Исключения

CILGException(ILG_E_HANDLE)

если дескриптор неправильный.

GetStatus()

ilg_status ilg::CAsyncCommand::GetStatus ( ) const

inline

Возвращает состояние команды.

Возвращает

Состояние команды: =ILG_E_PENDING команда ещё выполняется, иначе - завершена.

Исключения

CILGException(ILG_E_HANDLE)

если дескриптор неправильный.

---

Объявления и описания членов классов находятся в файлах:

• ilg_cpp_helpers.h
• ilg_cpp_helpers.cpp