Класс ConsoleReference
Публичные типы
| enum | SecurityMode { SecurityDisabled , SecurityEnabled } |
Сигналы
| void | bytesWritten (int bytes) |
| void | inputClosed () |
| void | outputClosed () |
| void | readyRead () |
Публичные функции
| int | bytesAvailable () const |
| int | bytesToWrite () const |
| void | closeOutput () |
| Console * | console () const |
| ConsoleReference (QObject *parent=nullptr) | |
| QByteArray | read (int bytes=-1) |
| SecureArray | readSecure (int bytes=-1) |
| SecurityMode | securityMode () const |
| bool | start (Console *console, SecurityMode mode=SecurityDisabled) |
| void | stop () |
| void | write (const QByteArray &a) |
| void | writeSecure (const SecureArray &a) |
Дружественные функции и классы
| class | Console |
| class | ConsoleReferencePrivate |
Подробное описание
Менеджер объектов Console.
Примечание.
Одновременно может быть активен только один объект ConsoleReference.
Описание перечислений
SecurityMode
| enum QCA::ConsoleReference::SecurityMode |
Параметр безопасности, используемый для управляемого объекта Console.
Описание конструкторов и деструктора
ConsoleReference()
| QCA::ConsoleReference::ConsoleReference (QObject * parent = nullptr) |
Стандартный конструктор.
Параметры
| parent | Родительский объект для этого экземпляра |
Описание методов
start()
| bool QCA::ConsoleReference::start (Console * console, SecurityMode mode = SecurityDisabled) |
Устанавливает объект Console как управляемый и начинает обработку.
Обычно используется Console::ttyInstance() или Console::stdioInstance() для получения необходимой ссылки на объект Console.
Параметры
| console | Ссылка на управляемый объект Console |
| mode | Ссылка на управляемый объект Console |
См. также QCA::Console для получения дополнительной информации о том, как обрабатывать аспекты console приложения или кода библиотеки.
stop()
| void QCA::ConsoleReference::stop () |
Останавливает обработку и выпускает Console.
console()
| Console* QCA::ConsoleReference::console () const |
Объект Console, управляемый этим объектом.
См. также start() , чтобы настроить Console для управления.
securityMode()
| SecurityMode QCA::ConsoleReference::securityMode () const |
Настройка параметра безопасности для объекта Console, управляемого этим объектом.
См. также start() для установки SecurityMode
read()
| QByteArray QCA::ConsoleReference::read (int bytes = -1) |
Считывает данные из объекта Console.
Параметры
| bytes | Количество байтов для чтения. По умолчанию считываются все доступные байты |
См. также readSecure() для метода, подходящего для чтения конфиденциальных данных.
write()
| void QCA::ConsoleReference::write (const QByteArray & a) |
Записывает данные в объект Console.
Параметры
| a | Массив данных для записи в Console |
См. также writeSecure() для метода, подходящего для записи конфиденциальных данных.
readSecure()
| SecureArray QCA::ConsoleReference::readSecure (int bytes = -1) |
Считывает защищенные данные из объекта Console.
Параметры
| bytes | Количество байтов для чтения. По умолчанию считываются все доступные байты |
См. также read(), который подходит для не конфиденциальных данных.
writeSecure()
| void QCA::ConsoleReference::writeSecure (const SecureArray & a) |
Записывает защищенные данные в объект Console.
Параметры
| a | Массив данных для записи в Console |
См. также write(), который подходит для не конфиденциальных данных
closeOutput()
| void QCA::ConsoleReference::closeOutput () |
Закрывает канал записи.
Необходимо вызывать только в том случае, если запись разрешена на управляемой Console.
bytesAvailable()
| int QCA::ConsoleReference::bytesAvailable () const |
Количество байтов, доступных для чтения из управляемой Console.
bytesToWrite()
| int QCA::ConsoleReference::bytesToWrite () const |
Количество байтов, оставшихся для записи в управляемую Console.
readyRead
| void QCA::ConsoleReference::readyRead () | signal |
Вызывается, когда есть байты, доступные для чтения из управляемой Console.
bytesWritten
| void QCA::ConsoleReference::bytesWritten (int bytes) | signal |
Вызывается, когда байты записываются в Console.
Параметры
| bytes | Количество байтов, которые были записаны |
См. также bytesAvailable()
inputClosed
| void QCA::ConsoleReference::inputClosed () | signal |
Вызывается при закрытии возможности ввода в консоли.
outputClosed
| void QCA::ConsoleReference::outputClosed () | signal |
Вызывается при закрытии возможности вывода в консоли.