Класс QPipeEnd
Публичные типы
| enum | Error { ErrorEOF , ErrorBroken } |
Сигналы
| void | bytesWritten (int bytes) |
| void | closed () |
| void | error (QCA::QPipeEnd::Error e) |
| void | readyRead () |
Публичные функции
| int | bytesAvailable () const |
| int | bytesToWrite () const |
| void | close () |
| void | enable () |
| void | finalize () |
| void | finalizeAndRelease () |
| Q_PIPE_ID | id () const |
| int | idAsInt () const |
| bool | isValid () const |
| QPipeEnd (QObject *parent=nullptr) | |
| QByteArray | read (int bytes=-1) |
| SecureArray | readSecure (int bytes=-1) |
| void | release () |
| void | reset () |
| bool | setInheritable (bool enabled) |
| void | setSecurityEnabled (bool secure) |
| void | take (Q_PIPE_ID id, QPipeDevice::Type t) |
| QByteArray | takeBytesToWrite () |
| SecureArray | takeBytesToWriteSecure () |
| QPipeDevice::Type | type () const |
| void | write (const QByteArray &a) |
| void | writeSecure (const SecureArray &a) |
Дружественные функции и классы
| class | Private |
Подробное описание
Буферный канал более высокого уровня.
Это или читаемый, или записываемый участник QPipe.
Описание перечислений
Error
| enum QCA::QPipeEnd::Error |
Тип ошибки.
| ErrorEOF | Ошибка конца файла |
| ErrorBroken | Ошибка сломанного канала |
Описание конструкторов и деструктора
QPipeEnd()
| QCA::QPipeEnd::QPipeEnd (QObject * parent = nullptr) |
Стандартный конструктор.
Параметры
| parent | Родительский объект для этого экземпляра |
Описание методов
reset()
| void QCA::QPipeEnd::reset () |
Сбрасывает канал в неактивное состояние.
type()
| QPipeDevice::Type QCA::QPipeEnd::type () const |
Тип конца канала (чтение или запись).
isValid()
| bool QCA::QPipeEnd::isValid () const |
Определяет, действителен ли участник канала.
Примечание.
Результат не означает, что канал готов к использованию — может потребоваться сначала вызвать enable().
id()
| Q_PIPE_ID QCA::QPipeEnd::id () const |
Идентификация канала.
idAsInt()
| int QCA::QPipeEnd::idAsInt () const |
Идентификация канала.
take()
| void QCA::QPipeEnd::take (Q_PIPE_IDid, QPipeDevice::Type t ) |
Принимает существующий идентификатор канала.
Параметры
| id | Идентификатор канала |
| t | Тип канала (чтение или запись) |
setSecurityEnabled()
| void QCA::QPipeEnd::setSecurityEnabled (bool secure) |
Устанавливает, использует ли канал безопасную память для чтения/записи.
Включение этого параметра может снизить производительность, и его следует использовать только в том случае, если передаются конфиденциальные данные (например, кодовая фраза).
Параметры
| secure | Использует ли канал безопасную память (true) или нет (false) |
enable()
| void QCA::QPipeEnd::enable () |
Включает конечную точку для канала.
Когда конечная точка создана, её нельзя использовать, пока она не будет включена.
close()
| void QCA::QPipeEnd::close () |
Закрывает канал.
См. также closed()
release()
| void QCA::QPipeEnd::release () |
Отпускает активный канал, но не закрывает его.
Следует использовать этот метод перед уничтожением
QPipeEnd, если нужно, чтобы канал не
закрывался автоматически.
setInheritable()
| bool QCA::QPipeEnd::setInheritable (bool enabled) |
Устанавливает, должны ли дочерние процессы наследовать канал.
Возвращает true, если наследование было успешно изменено, иначе false.
Параметры
| enabled | Является ли канал наследуемым (true) или нет (false) |
finalize()
| void QCA::QPipeEnd::finalize () |
Очищает содержимое канала и аннулирует канал.
finalizeAndRelease()
| void QCA::QPipeEnd::finalizeAndRelease () |
Очищает содержимое канала и освобождает канал.
bytesAvailable()
| int QCA::QPipeEnd::bytesAvailable () const |
Определяет, сколько байтов доступно для чтения.
Метод имеет смысл только для читаемого участника канала.
См. также readyRead() для сигнала, который можно использовать для определения наличия байтов, доступных для чтения.
bytesToWrite()
| int QCA::QPipeEnd::bytesToWrite () const |
Возвращает количество байтов, ожидающих записи.
Метод имеет смысл только для записываемого участника канала.
См. также bytesWritten() для сигнала, который может использоваться, чтобы определить, когда байты были записаны.
read()
| QByteArray QCA::QPipeEnd::read (int bytes = -1) |
Читает байты из канала.
Метод можно вызвать только на читаемом участнике канала.
Если канал использует безопасную память, следует использовать readSecure().
Параметры
| bytes | Количество байтов для чтения (-1 для всего содержимого) |
write()
| void QCA::QPipeEnd::write (const QByteArray & a) |
Записывает байты в канал.
Метод можно вызвать только на записываемом участнике канала.
Если канал использует безопасную память, следует использовать writeSecure().
Параметры
| a | Массив для записи в канал |
readSecure()
| SecureArray QCA::QPipeEnd::readSecure (int bytes = -1) |
Читает байты из канала.
Метод можно вызвать только на читаемом участнике канала.
Если канал использует небезопасную память, следует использовать read().
Параметры
| bytes | Количество байтов для чтения (-1 для всего содержимого) |
writeSecure()
| void QCA::QPipeEnd::writeSecure (const SecureArray & a) |
Записывает байты в канал.
Метод можно вызвать только на записываемом участнике канала.
Если канал использует небезопасную память, следует использовать write().
Параметры
| a | Массив для записи в канал |
takeBytesToWrite()
| QByteArray QCA::QPipeEnd::takeBytesToWrite () |
Возвращает все неотправленные байты, поставленные в очередь на запись.
Если канал использует безопасную память, следует использовать takeBytesToWriteSecure().
takeBytesToWriteSecure()
| SecureArray QCA::QPipeEnd::takeBytesToWriteSecure () |
Возвращает все неотправленные байты, поставленные в очередь на запись.
Если канал использует небезопасную память, следует использовать takeBytesToWrite().
readyRead
| void QCA::QPipeEnd::readyRead () | signal |
Сигнал испускается, когда есть байты, доступные для чтения из читаемого конца канала.
См. также bytesAvailable()
bytesWritten
| void QCA::QPipeEnd::bytesWritten (int bytes) | signal |
Сигнал испускается, когда когда байты были записаны по каналу.
Параметры
| bytes | Количество записанных байтов |
closed
| void QCA::QPipeEnd::closed () | signal |
Сигнал испускается, когда этот канал закрывается в результате вызова close().
Если это записываемый участник канала и имеются данные, ожидающие записи, сигнал будет испущен после того, как все данные будут записаны.
Чтобы получить уведомление, когда другой участник канала был закрыт, см. error().
error
| void QCA::QPipeEnd::error (QCA::QPipeEnd::Error e) | signal |
Сигнал испускается, когда канал обнаруживает ошибку при попытке чтения или записи, или если другой участник канала был закрыт.
Параметры
| e | Причина ошибки |