Класс QLocalSocket

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

Этот класс был представлен в Qt 4.4.

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

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

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

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

Сигналы

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

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

В 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] 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().

void QLocalSocket::connectToServer(QIODevice::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, QIODevice::OpenMode openMode = ReadWrite)

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

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

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

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

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

void QLocalSocket::disconnectFromServer()

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

См. также 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(QIODevice::OpenMode openMode = ReadWrite)

Переопределяет: QIODevice::open(QIODevice::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().

void QLocalSocket::setServerName(const QString &name)

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

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

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

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

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

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

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

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

qintptr QLocalSocket::socketDescriptor() const

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

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

• В Windows возвращаемое значение является Winsock 2 Socket Handle.
• С WinRT и в 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).