Функции и типы, связанные с связью с конвертером. Подробнее...
Классы | |
struct | ilg_license_info |
Информация о лицензии конвертера. Подробнее... | |
struct | ilg_converter_options |
Настройки конвертера. Подробнее... | |
Определения типов | |
typedef void(ILG_CALL * | ilg_converter_message_callback) (ilg_converter_msg nMsg, const void *pMsgData, void *pUserData) |
Тип функции обратного вызова для получения уведомлений от дескриптора конвертера. Подробнее... | |
Перечисления | |
enum | ilg_connection_status { ILG_CONNECTION_DISCONNECTED , ILG_CONNECTION_CONNECTED , ILG_CONNECTION_CONNECTING , ILG_CONNECTION_SIZE } |
Состояние подключения к конвертеру/контроллеру. Подробнее... | |
enum | ilg_converter_msg { ILG_CONVERTER_MSG_COMMAND_FINISH , ILG_CONVERTER_MSG_CONNECTION_CHANGED , ILG_CONVERTER_MSG_CONTROLLER_FOUND , ILG_CONVERTER_MSG_CONTROLLER_LOST , ILG_CONVERTER_MSG_CONTROLLER_LIST_CHANGED , ILG_CONVERTER_MSG_CONTROLLER_ADDRESS_CHAMGED } |
Сообщение конвертера. Подробнее... | |
Функции и типы, связанные с связью с конвертером.
Ссылки на инфо о создании дескриптора конвертера, настройке параметров связи с конвертером, подключение к конвертеру.
typedef void(ILG_CALL * ilg_converter_message_callback) (ilg_converter_msg nMsg, const void *pMsgData, void *pUserData) |
Тип функции обратного вызова для получения уведомлений от дескриптора конвертера.
[in] | nMsg | Тип сообщения. |
[in] | pMsgData | Указатель на данные сообщения. Тип данных зависит от типа сообщения. |
[in] | pUserData | Указатель на данные пользователя. |
pMsgData
действителен до выхода из этой функции. enum ilg_converter_msg |
Сообщение конвертера.
Элементы перечислений | |
---|---|
ILG_CONVERTER_MSG_COMMAND_FINISH | Завершилась асинхронная команда, созданная функцией с префиксом "ilg_converter_begin_". Параметр - дескриптор команды (дескриптор действителен до следующего сообщения этого типа или до следующего вызова GetMessage), его не нужно закрывать функцией ilg_close_handle. |
ILG_CONVERTER_MSG_CONNECTION_CHANGED | Изменилось состояние подключения к конвертеру. Узнать текущее состояние можно функцией ilg_converter_get_connection_status. |
ILG_CONVERTER_MSG_CONTROLLER_FOUND | Контроллер найден, параметр ilg_controller_info*. |
ILG_CONVERTER_MSG_CONTROLLER_LOST | Контроллер потерян, параметр ilg_controller_info*. |
ILG_CONVERTER_MSG_CONTROLLER_LIST_CHANGED | Изменён список контроллеров. |
ILG_CONVERTER_MSG_CONTROLLER_ADDRESS_CHAMGED | Изменён адрес контроллера. |
ILG_API ilg_status ILG_CALL ilg_converter_begin_clear_licenses | ( | ilg_handle | hConverter, |
ilg_bool | fDisconnect, | ||
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду удаления всех лицензий.
[in] | hConverter | Дескриптор конвертера. |
[in] | fDisconnect | ILG_TRUE , после установки лицензии отключается от конвертера , иначе - устанавливает лицензию #5 по умолчанию. |
[out] | pCommand | Дескриптор команды. |
Advanced
конвертера. ILG_API ilg_status ILG_CALL ilg_converter_begin_connect | ( | ilg_handle | hConverter, |
ilg_bool | fReconnect, | ||
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду подключения к конвертеру.
[in] | hConverter | Дескриптор конвертера. |
[in] | fReconnect | ILG_TRUE , переподключиться. |
[out] | pCommand | Дескриптор команды. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_begin_disconnect | ( | ilg_handle | hConverter, |
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду отключения от конвертера.
[in] | hConverter | Дескриптор конвертера. |
[out] | pCommand | Дескриптор команды. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_begin_get_license_count | ( | ilg_handle | hConverter, |
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду получения количества установленных лицензий.
[in] | hConverter | Дескриптор конвертера. |
[out] | pCommand | Дескриптор команды. |
Advanced
конвертера. ILG_API ilg_status ILG_CALL ilg_converter_begin_read_license_info | ( | ilg_handle | hConverter, |
uint32_t | nLicenseN, | ||
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду запроса инфо о лицензии конвертера.
[in] | hConverter | Дескриптор конвертера. |
[in] | nLicenseN | Номер лицензии, информацию о которой нужно получить. |
[out] | pCommand | Дескриптор команды. |
Advanced
конвертера.ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_begin_set_firmware | ( | ilg_handle | hConverter, |
const void * | pData, | ||
size_t | nSize, | ||
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду установки прошивки конвертера.
[in] | hConverter | Дескриптор конвертера. |
[in] | pData | Данные прошивки. |
[in] | nSize | Размер данных прошивки в байтах. |
[out] | pCommand | Дескриптор команды. |
ILG_API ilg_status ILG_CALL ilg_converter_begin_write_license | ( | ilg_handle | hConverter, |
const void * | pData, | ||
size_t | nSize, | ||
uint32_t | nLicenseN, | ||
ilg_handle * | pCommand | ||
) |
Запускает асинхронную команду установки лицензии в конвертер.
[in] | hConverter | Дескриптор конвертера. |
[in] | pData | Данные лицензии. |
[in] | nSize | Количество байт данных лицензии. |
[in] | nLicenseN | Номер лицензии. |
[out] | pCommand | Дескриптор команды. |
Advanced
конвертера. ILG_API ilg_status ILG_CALL ilg_converter_clear_licenses | ( | ilg_handle | hConverter, |
ilg_bool | fDisconnect = ILG_FALSE |
||
) |
Удаляет все лицензии.
[in] | hConverter | Дескриптор конвертера. |
[in] | fDisconnect | ILG_TRUE , после установки лицензии отключается от конвертера , иначе - устанавливает лицензию #5 по умолчанию. |
Advanced
конвертера. ILG_API ilg_status ILG_CALL ilg_converter_connect | ( | ilg_handle | hConverter, |
ilg_bool | fReconnect = ILG_FALSE |
||
) |
Подключается к конвертеру.
[in] | hConverter | Дескриптор конвертера. |
[in] | fReconnect | ILG_TRUE , Отключается перед подключением. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_disconnect | ( | ilg_handle | hConverter | ) |
Отключается от конвертера.
[in] | hConverter | Дескриптор конвертера. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_enable_message_queue | ( | ilg_handle | hConverter, |
ilg_bool | fEnable = ILG_TRUE |
||
) |
Включает/выключает очередь сообщений.
Эта функция устанавливает/снимает флаг в дескрипторе конвертера. Очередь сообщений предназначена для синхронизации обработки сообщений.
[in] | hConverter | Дескриптор конвертера. |
[in] | fEnable | ILG_TRUE , включает очередь, иначе - выключает. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_end_get_license_count | ( | ilg_handle | hCommand, |
size_t * | pCount | ||
) |
Возвращает количество установленных лицензий.
[in] | hCommand | Дескриптор команды, которую вернула функция ilg_converter_begin_get_license_count. |
[out] | pCount | Количество установленных лицензий. |
ILG_API ilg_status ILG_CALL ilg_converter_end_read_license_info | ( | ilg_handle | hCommand, |
ilg_license_info * | pInfo | ||
) |
Возвращает результат запроса инфо о лицензии конвертера.
[in] | hCommand | Дескриптор команды, которую вернула функция ilg_converter_begin_read_license_info. |
[out] | pInfo | Информация о лицензии конвертера. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_end_write_license | ( | ilg_handle | hCommand, |
ilg_license_info * | pInfo | ||
) |
Возвращает результат установки лицензии в конвертер.
[in] | hCommand | Дескриптор команды, которую вернула функция ilg_converter_begin_write_license. |
[out] | pInfo | Информация о лицензии. |
ILG_API ilg_status ILG_CALL ilg_converter_get_connection_status | ( | ilg_handle | hConverter, |
ilg_connection_status * | pStatus | ||
) |
Возвращает состояние подключения к конвертеру.
[in] | hConverter | Дескриптор конвертера. |
[out] | pStatus | Состояние подключения к конвертеру. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_get_info | ( | ilg_handle | hConverter, |
ilg_converter_info * | pInfo | ||
) |
Возвращает информацию о конвертере.
[in] | hConverter | Дескриптор конвертера. |
[out] | pInfo | Информация о конвертере. |
pInfo
ссылки pszPortName
и pszConnect
действительны пока жив дескриптор hConverter
.ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_get_license_count | ( | ilg_handle | hConverter, |
size_t * | pCount | ||
) |
Возвращает количество установленных лицензий.
[in] | hConverter | Дескриптор конвертера. |
[out] | pCount | Количество установленных лицензий. |
*pCount
в переменной, и уже её использовать в цикле.Advanced
конвертера.ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_get_license_info | ( | ilg_handle | hConverter, |
size_t | nIdx, | ||
ilg_license_info * | pInfo | ||
) |
Возвращает инфо о лицензии из списка, полученного методом ilg_converter_get_license_count.
[in] | hConverter | Дескриптор конвертера. |
[in] | nIdx | Позиция в списке. |
[out] | pInfo | Информация о лицензии. |
ILG_API ilg_status ILG_CALL ilg_converter_get_message | ( | ilg_handle | hConverter, |
ilg_converter_msg * | pMsg, | ||
const void ** | pMsgData, | ||
ilg_bool * | pFound | ||
) |
Извлекает следующее сообщение из очереди.
[in] | hConverter | Дескриптор конвертера. |
[out] | pMsg | Тип сообщения. |
[out] | pMsgData | Указатель на данные пользователя, которые были установлены функцией ilg_converter_set_message_callback. |
[out] | pFound | ILG_TRUE , если сообщение успешно извлечено, иначе - очередь пуста. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_get_options | ( | ilg_handle | hConverter, |
ilg_converter_options * | pOptions | ||
) |
Возвращает параметры конвертера.
[in] | hConverter | Дескриптор конвертера. |
[in] | pOptions | Параметры конвертера. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_read_license_info | ( | ilg_handle | hConverter, |
ilg_license_info * | pInfo, | ||
uint32_t | nLicenseN = ILG_LICENSE_N , |
||
ilg_bool | fForce = ILG_FALSE |
||
) |
Возвращает информацию о лицензии конвертера.
[in] | hConverter | Дескриптор конвертера. |
[out] | pInfo | Информация о лицензии. |
[in] | nLicenseN | Номер лицензии, информацию о которой нужно получить. По умолчанию =5. |
[in] | fForce | ILG_TRUE , прочитать инфо из конвертера, иначе взять из кэша (только лицензия №5) |
fForce
равен ILG_TRUE или nLicenseN
не равен ILG_LICENSE_N
, то функция не возвращает управление пока ждёт выполнение команды в потоке конвертера. Работает только в режиме Advanced
конвертера.ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_set_firmware | ( | ilg_handle | hConverter, |
const void * | pData, | ||
size_t | nSize | ||
) |
Устанавливает прошивку в конвертер.
[in] | hConverter | Дескриптор конвертера. |
[in] | pData | Данные прошивки. |
[in] | nSize | Размер данных прошивки в байтах. |
ILG_API ilg_status ILG_CALL ilg_converter_set_message_callback | ( | ilg_handle | hConverter, |
ilg_converter_message_callback | pCallback, | ||
void * | pUserData = nullptr |
||
) |
Устанавливает функцию обратного вызова для уведомлений конвертера.
Устанавливает функцию для получения сообщений от дескриптора конвертера.
[in] | hConverter | Дескриптор конвертера. |
[in] | pCallback | Указатель на функцию, которую библиотека будет вызывать при возникновении события конвертера. |
[in] | pUserData | Указатель на данные пользователя, который будет передаваться в функцию. |
try catch
. Нельзя из callback-функции вызывать функции, которые ждут выполнение команды в потоке, из которого вызвана эта callback-функция, иначе вернёт ошибку ILG_E_BLOCKING_CALL_NOT_ALLOWED
.ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_set_options | ( | ilg_handle | hConverter, |
const ilg_converter_options * | pOptions | ||
) |
Устанавливает параметры конвертера.
[in] | hConverter | Дескриптор конвертера. |
[in] | pOptions | Параметры конвертера. |
ILG_OK
в случае успеха или код ошибки в случае неудачи. ILG_API ilg_status ILG_CALL ilg_converter_write_license | ( | ilg_handle | hConverter, |
const void * | pData, | ||
size_t | nSize, | ||
ilg_license_info * | pInfo = nullptr , |
||
uint32_t | nLicenseN = ILG_LICENSE_N |
||
) |
Устанавливает лицензию в конвертер.
[in] | hConverter | Дескриптор конвертера. |
[in] | pData | Данные лицензии. |
[in] | nSize | Количество байт данных лицензии. |
[out] | pInfo | Информация о лицензии. Может быть равен nullptr . |
[in] | nLicenseN | Номер лицензии. |
Advanced
конвертера. ILG_API ilg_status ILG_CALL ilg_get_converter | ( | ilg_port_type | nPortType, |
const char * | pszPortName, | ||
ilg_handle * | pConverter | ||
) |
Создаёт дескриптор конвертера.
[in] | nPortType | Тип порта. |
[in] | pszPortName | Имя порта. |
[out] | pConverter | Дескриптор конвертера. |
ILG_OK
в случае успеха или код ошибки в случае неудачи.