Класс QLocalSocket

Класс QLocalSocket предоставляет локальный сокет. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

Переопределённые открытые функции

Сигналы

Переопределённые защищённые функции

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

В Windows это именованная труба, а в Unix — локальный сокет доменной области.

Если произошла ошибка, error() возвращает тип ошибки, а errorString() можно вызвать, чтобы получить удобочитаемое описание того, что произошло.

Хотя QLocalSocket предназначен для использования с циклом обработки событий, его можно использовать и без него. В этом случае необходимо использовать waitForConnected(), waitForReadyRead(), waitForBytesWritten() и waitForDisconnected(), которые блокируют выполнение, пока операция не завершится или не истечёт время ожидания.

См. также QLocalServer.

Документация по типам членов

перечисление QLocalSocket::LocalSocketError

Перечисление LocalServerError представляет ошибки, которые могут возникнуть. Последнюю ошибку можно получить с помощью вызова QLocalSocket::error().

enum QLocalSocket::LocalSocketState

Этот перечисление описывает различные состояния, в которых может находиться сокет.

См. также QLocalSocket::state().

Документация функций-членов

QLocalSocket::QLocalSocket(QObject *parent = nullptr)

Создаёт новый локальный сокет. Аргумент parent передаётся конструктору QObject.

[signal] void QLocalSocket::connected()

Этот сигнал испускается после вызова connectToServer() и успешной установке соединения.

См. также connectToServer() и disconnected().

[signal] void QLocalSocket::disconnected()

Этот сигнал испускается, когда сокет был отключён.

См. также connectToServer(), disconnectFromServer(), abort() и connected().

[signal, since 5.15] void QLocalSocket::errorOccurred(QLocalSocket::LocalSocketError socketError)

Этот сигнал испускается после возникновения ошибки. Параметр socketError описывает тип произошедшей ошибки.

QLocalSocket::LocalSocketError — не зарегистрированный тип метаданных, поэтому для очередей подключений вам нужно зарегистрировать его с помощью Q_DECLARE_METATYPE() и qRegisterMetaType().

Эта функция была добавлена в Qt 5.15.

См. также error(), errorString() и Создание пользовательских типов Qt.

[signal] void QLocalSocket::stateChanged(QLocalSocket::LocalSocketState socketState)

Этот сигнал испускается всякий раз, когда состояние QLocalSocket меняется. Параметр socketState — новое состояние.

QLocalSocket::SocketState — не зарегистрированный тип метаданных, поэтому для очередей подключений вам нужно зарегистрировать его с помощью Q_DECLARE_METATYPE() и qRegisterMetaType().

См. также state() и Создание пользовательских типов Qt.

[virtual] QLocalSocket::~QLocalSocket()

Уничтожает сокет, закрывая соединение при необходимости.

void QLocalSocket::abort()

Прерывает текущее соединение и сбрасывает сокет. В отличие от disconnectFromServer(), эта функция немедленно закрывает сокет, очищая любые ожидающие данные в буфере записи.

См. также disconnectFromServer() и close().

[override virtual] qint64 QLocalSocket::bytesAvailable() const

Переопределяет: QIODevice::bytesAvailable() const.

[override virtual] qint64 QLocalSocket::bytesToWrite() const

Переопределяет: QIODevice::bytesToWrite() const.

[override virtual] bool QLocalSocket::canReadLine() const

Переопределяет: QIODevice::canReadLine() const.

[override virtual] void QLocalSocket::close()

Переопределяет: QIODevice::close().

[since 5.1] void QLocalSocket::connectToServer(QIODeviceBase::OpenMode openMode = ReadWrite)

Попытка установить соединение с serverName(). Необходимо вызвать setServerName() перед открытием соединения. В качестве альтернативы можно использовать connectToServer(const QString &name, OpenMode openMode);

Сокет открывается с заданным openMode и сначала переходит в состояние ConnectingState. Если соединение установлено, QLocalSocket переходит в состояние ConnectedState и испускает сигнал connected().

После вызова этой функции, сокет может испустить errorOccurred() для сигнализации об ошибке.

Эта функция была добавлена в Qt 5.1.

См. также state(), serverName() и waitForConnected().

void QLocalSocket::connectToServer(const QString &name, QIODeviceBase::OpenMode openMode = ReadWrite)

Это перегруженная функция.

Устанавливает серверное имя и пытается подключиться к нему.

Сокет открывается с заданным openMode и сначала переходит в состояние ConnectingState. Если соединение установлено, QLocalSocket переходит в состояние ConnectedState и испускает сигнал connected().

После вызова этой функции, сокет может испустить errorOccurred() для сигнализации об ошибке.

См. также state(), serverName() и waitForConnected().

void QLocalSocket::disconnectFromServer()

Попытка закрыть сокет. Если есть ожидающие записи данных, QLocalSocket перейдёт в состояние ClosingState и подождёт, пока все данные не будут записаны. В конечном итоге он перейдёт в состояние UnconnectedState и испустит сигнал disconnected().

См. также connectToServer().

QLocalSocket::LocalSocketError QLocalSocket::error() const

Возвращает тип последней произошедшей ошибки.

См. также state() и errorString().

bool QLocalSocket::flush()

Эта функция записывает как можно больше данных из внутреннего буфера записи в сокет, без блокировки. Если данные были записаны, функция возвращает true; в противном случае возвращается false.

Вызовите эту функцию, если необходимо, чтобы QLocalSocket начал отправлять данные из буфера немедленно. Количество успешно записанных байтов зависит от операционной системы. В большинстве случаев вызывать эту функцию не нужно, так как QLocalSocket начнет отправлять данные автоматически, когда управление вернется в цикл событий. При отсутствии цикла событий используйте waitForBytesWritten() вместо этого.

См. также write() и waitForBytesWritten().

QString QLocalSocket::fullServerName() const

Возвращает путь к серверу, к которому подключен сокет.

Примечание: Возвращаемое значение этой функции зависит от платформы.

См. также connectToServer() и serverName().

[override virtual] bool QLocalSocket::isSequential() const

Переопределяет: QIODevice::isSequential() const.

bool QLocalSocket::isValid() const

Возвращает true, если сокет валиден и готов к использованию; в противном случае возвращает false.

Примечание: Состояние сокета должно быть ConnectedState перед чтением и записью.

См. также state() и connectToServer().

[override virtual] bool QLocalSocket::open(QIODeviceBase::OpenMode openMode = ReadWrite)

Переопределяет: QIODevice::open(QIODeviceBase::OpenMode mode).

Эквивалентно connectToServer(OpenMode mode). Сокет открывается в заданном openMode для сервера, определенного функцией setServerName().

Обратите внимание, что в отличие от большинства других подклассов QIODevice, open() может не открывать устройство напрямую. Функция возвращает false, если сокет уже был подключен или сервер для подключения не был определен, и true в противном случае. Сигналы connected() или errorOccurred() будут выпущены, как только устройство будет фактически открыто (или подключение завершилось ошибкой).

Для получения дополнительной информации см. connectToServer().

qint64 QLocalSocket::readBufferSize() const

Возвращает размер внутреннего буфера чтения. Это ограничивает количество данных, которые клиент может получить, прежде чем вы вызовете read() или readAll(). Размер буфера чтения 0 (по умолчанию) означает, что буфер не имеет ограничений по размеру, гарантируя, что данные не потеряны.

См. также setReadBufferSize() и read().

[override virtual protected] qint64 QLocalSocket::readData(char *data, qint64 c)

Переопределяет: QIODevice::readData(char *data, qint64 maxSize).

QString QLocalSocket::serverName() const

Возвращает имя удаленного узла, заданное функцией setServerName(), или пустую строку QString, если setServerName() не вызывалась или подключение connectToServer() завершилось ошибкой.

См. также setServerName(), connectToServer() и fullServerName().

void QLocalSocket::setReadBufferSize(qint64 size)

Устанавливает размер внутреннего буфера чтения QLocalSocket в size байт.

Если размер буфера ограничен определенным размером, QLocalSocket не будет буферизовать больше данных, чем этот размер. Исключением является буфер размера 0, что означает неограниченный буфер чтения, и все входящие данные буферизуются. Это значение по умолчанию.

Эта опция полезна, если вы читаете данные только в определенные моменты времени (например, в приложении реального времени потоковой передачи) или если хотите защитить свой сокет от получения слишком большого объема данных, что может привести к недостатку памяти в вашем приложении.

См. также readBufferSize() и read().

[since 5.1] void QLocalSocket::setServerName(const QString &name)

Устанавливает имя удаленного узла для подключения. В Windows имя — это имя именованной трубы; в Unix — имя локального сокета домена.

Эта функция должна вызываться, когда сокет не подключен.

Функция была добавлена в Qt 5.1.

См. также serverName().

bool QLocalSocket::setSocketDescriptor(qintptr socketDescriptor, QLocalSocket::LocalSocketState socketState = ConnectedState, QIODeviceBase::OpenMode openMode = ReadWrite)

Инициализирует QLocalSocket с помощью дескриптора родного сокета socketDescriptor. Возвращает true если socketDescriptor принят как валидный дескриптор сокета; в противном случае возвращает false. Сокет открывается в режиме, указанном в openMode, и переходит в состояние сокета, указанное в socketState.

Примечание: Невозможно инициализировать два локальных сокета с одним и тем же дескриптором родного сокета.

См. также socketDescriptor(), state() и openMode().

[override virtual protected] qint64 QLocalSocket::skipData(qint64 maxSize)

Переопределяет: QIODevice::skipData(qint64 maxSize).

qintptr QLocalSocket::socketDescriptor() const

Возвращает дескриптор родного сокета объекта QLocalSocket, если он доступен; в противном случае возвращает -1.

Дескриптор сокета недоступен, когда QLocalSocket находится в состоянии UnconnectedState. Тип дескриптора зависит от платформы:

• В Windows возвращаемое значение — это Winsock 2 Socket Handle.
• В INTEGRITY возвращаемое значение — это дескриптор сокета QTcpSocket, а тип определяется функцией socketDescriptor.
• Во всех других операционных системах типа Unix, тип — это дескриптор файла, представляющий сокет.

См. также setSocketDescriptor().

QLocalSocket::LocalSocketState QLocalSocket::state() const

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

См. также error().

[override virtual] bool QLocalSocket::waitForBytesWritten(int msecs = 30000)

Переопределяет: QIODevice::waitForBytesWritten(int msecs).

bool QLocalSocket::waitForConnected(int msecs = 30000)

Ожидает подключения к сокету в течение msecs миллисекунд. Если подключение установлено, функция возвращает true; в противном случае возвращает false. В случае возвращения false, можно вызвать error() для определения причины ошибки.

Следующий пример ожидает подключения в течение одной секунды:

socket->connectToServer("market");
if (socket->waitForConnected(1000))
    qDebug("Connected!");

Если msecs равно -1, функция не будет ожидать.

См. также connectToServer() и connected().

bool QLocalSocket::waitForDisconnected(int msecs = 30000)

Ожидает разъединения сокета в течение msecs миллисекунд. Если разъединение прошло успешно, функция возвращает true; в противном случае возвращает false (если операция завершилась по истечении времени ожидания, если произошла ошибка или этот QLocalSocket уже отключен). В случае возвращения false, можно вызвать error() для определения причины ошибки.

Следующий пример ожидает закрытия подключения в течение одной секунды:

socket->disconnectFromServer();
if (socket->state() == QLocalSocket::UnconnectedState
    || socket->waitForDisconnected(1000)) {
    qDebug("Disconnected!");
}

Если msecs равно -1, функция не будет ожидать.

См. также disconnectFromServer() и close().

[override virtual] bool QLocalSocket::waitForReadyRead(int msecs = 30000)

Переопределяет: QIODevice::waitForReadyRead(int msecs).

Эта функция блокируется до тех пор, пока данные не будут доступны для чтения, и сигнал readyRead() не будет испущен. Функция будет ожидать истечения времени после msecs миллисекунд; по умолчанию время ожидания составляет 30000 миллисекунд.

Функция возвращает true если данные доступны для чтения; в противном случае она возвращает false (если произошла ошибка или операция истекла).

См. также waitForBytesWritten().

[override virtual protected] qint64 QLocalSocket::writeData(const char *data, qint64 c)

Переопределяет: QIODevice::writeData(const char *data, qint64 maxSize).