Класс 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.

QLocalSocket:: connected()

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

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

QLocalSocket:: disconnected()

Этот сигнал испускается при отключении сокета.

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

QLocalSocket:: errorOccurred(QLocalSocket::LocalSocketError socketError)

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

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

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

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

QLocalSocket:: stateChanged(QLocalSocket::LocalSocketState socketState)

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

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

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

QLocalSocket::~QLocalSocket()

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

void QLocalSocket::abort()

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

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

qint64 QLocalSocket::bytesAvailable() const

Реализует: QIODevice::bytesAvailable() const.

qint64 QLocalSocket::bytesToWrite() const

Реализует: QIODevice::bytesToWrite() const.

bool QLocalSocket::canReadLine() const

Реализует: QIODevice::canReadLine() const.

void QLocalSocket::close()

Реализует: QIODevice::close().

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)

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

Устанавливает имя сервера 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(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)

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

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

Эта функция была добавлена в 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 дескриптором сокета.
• В 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).