Класс QAbstractSocket

Класс QAbstractSocket предоставляет базовые функции, общие для всех типов сокетов. Подробнее...

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

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

Общедоступные типы

Общедоступные функции

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

• 44 общедоступных функций унаследовано от QIODevice
• 31 общедоступных функций унаследовано от QObject

Сигналы

• 6 сигналов унаследовано от QIODevice
• 2 сигналов унаследовано от QObject

Статические общедоступные члены

• 9 статических общедоступных членов унаследовано от QObject

Защищённые функции

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

• 5 защищённых функций унаследовано от QIODevice
• 9 защищённых функций унаследовано от QObject

Дополнительные унаследованные члены

• 1 свойство унаследовано от QObject
• 1 общедоступный слот унаследован от QObject

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

Класс QAbstractSocket предоставляет базовые функции, общие для всех типов сокетов.

QAbstractSocket является базовым классом для QTcpSocket и QUdpSocket и содержит все общие функции этих двух классов. Если вам нужен сокет, у вас есть два варианта:

• Создайте экземпляр QTcpSocket или QUdpSocket.
• Создайте дескриптор сокета, создайте экземпляр QAbstractSocket и вызовите setSocketDescriptor() для обертывания нативного сокета.

TCP (Transmission Control Protocol) — это надёжный, ориентированный на потоки, ориентированный на соединение транспортный протокол. UDP (User Datagram Protocol) — это ненадежный, ориентированный на дейтаграммы, бессоединённый протокол. На практике это означает, что TCP лучше подходит для непрерывной передачи данных, а более лёгкий UDP может использоваться, когда надёжность не важна.

API QAbstractSocket объединяет большинство различий между двумя протоколами. Например, хотя UDP бессоединённый, connectToHost() устанавливает виртуальное соединение для UDP-сокетов, позволяя использовать QAbstractSocket более или менее одинаково независимо от основного протокола. Внутренне, QAbstractSocket запоминает адрес и порт, переданные в connectToHost(), а функции, такие как read() и write(), используют эти значения.

В любое время QAbstractSocket имеет состояние (возвращаемое state()). Начальное состояние — UnconnectedState. После вызова connectToHost() сокет сначала переходит в состояние HostLookupState. Если хост найден, QAbstractSocket переходит в состояние ConnectingState и излучает сигнал hostFound(). Когда соединение установлено, оно переходит в состояние ConnectedState и излучает connected(). Если в любой момент возникает ошибка, излучается error(). Всякий раз, когда состояние изменяется, излучается stateChanged(). Для удобства, isValid() возвращает true если сокет готов к чтению и записи, но обратите внимание, что состояние сокета должно быть ConnectedState перед чтением и записью.

Чтение или запись данных выполняется путём вызова read() или write(), или с использованием удобных функций readLine() и readAll(). QAbstractSocket также наследует getChar(), putChar() и ungetChar() от QIODevice, которые работают с одиночными байтами. Сигнал bytesWritten() излучается, когда данные были записаны в сокет. Обратите внимание, что Qt не ограничивает размер буфера записи. Вы можете отслеживать его размер, прослушивая этот сигнал.

Сигнал readyRead() излучается всякий раз, когда прибывает новый фрагмент данных. bytesAvailable() возвращает количество байтов, доступных для чтения. Обычно вы подключаете сигнал readyRead() к слоту и читаете все доступные данные там. Если вы не читаете все данные сразу, оставшиеся данные всё ещё будут доступны позже, и все новые входящие данные будут добавлены в внутренний буфер чтения QAbstractSocket. Чтобы ограничить размер буфера чтения, вызовите setReadBufferSize().

Для закрытия сокета вызовите disconnectFromHost(). QAbstractSocket переходит в состояние QAbstractSocket::ClosingState. После того, как все ожидающие данные будут записаны в сокет, QAbstractSocket фактически закрывает сокет, переходит в состояние QAbstractSocket::UnconnectedState и излучает disconnected(). Если вы хотите немедленно прервать соединение, удалив все ожидающие данные, вызовите abort() вместо этого. Если удалённый хост закрывает соединение, QAbstractSocket излучит ошибку (QAbstractSocket::RemoteHostClosedError), при этом состояние сокета всё ещё будет ConnectedState, а затем будет излучен сигнал disconnected().

Порт и адрес подключённого удалённого узла извлекаются путём вызова peerPort() и peerAddress(). peerName() возвращает имя хоста удалённого узла, переданное в connectToHost(). localPort() и localAddress() возвращают порт и адрес локального сокета.

QAbstractSocket предоставляет набор функций, которые приостанавливают вызывающую нить до тех пор, пока не будут излучены определённые сигналы. Эти функции могут использоваться для реализации блокирующих сокетов:

• waitForConnected() блокирует, пока не будет установлено соединение.
• waitForReadyRead() блокирует, пока новые данные не станут доступны для чтения.
• waitForBytesWritten() блокирует, пока один пакет данных не будет записан в сокет.
• waitForDisconnected() блокирует, пока соединение не будет закрыто.

Мы покажем пример:

    int numRead = 0, numReadTotal = 0;
    char buffer[50];

    forever {
        numRead  = socket.read(buffer, 50);

        // do whatever with array

        numReadTotal += numRead;
        if (numRead == 0 && !socket.waitForReadyRead())
            break;
    }

Если waitForReadyRead() возвращает false, соединение было закрыто или произошла ошибка.

Программирование с использованием блокирующего сокета радикально отличается от программирования с использованием неблокирующего сокета. Блокирующий сокет не требует цикла событий и, как правило, приводит к более простому коду. Однако в приложении с графическим интерфейсом блокирующие сокеты следует использовать только в не связанных с графическим интерфейсом потоках, чтобы избежать зависания пользовательского интерфейса. См. примеры fortuneclient и blockingfortuneclient для общего обзора обоих подходов.

Примечание: Мы не рекомендуем использовать блокирующие функции вместе с сигналами. Следует использовать один из двух возможных вариантов.

QAbstractSocket можно использовать с QTextStream и QDataStream операторами потока (operator<<() и operator>>()). Однако есть один момент, о котором следует знать: необходимо убедиться, что достаточное количество данных доступно перед попыткой их чтения с помощью operator>>().

См. также QNetworkAccessManager и QTcpServer.

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

enum QAbstractSocket::BindFlagflags QAbstractSocket::BindMode

Этот перечисление описывает различные флаги, которые можно передать для изменения поведения QAbstractSocket::bind().

Это перечисление было введено или изменено в Qt 5.0.

Тип BindMode является псевдонимом для QFlags<BindFlag>. Он хранит логическое ИЛИ сочетание значений BindFlag.

enum QAbstractSocket::NetworkLayerProtocol

Это перечисление описывает значения протокола сетевого уровня, используемые в Qt.

См. также QHostAddress::protocol().

enum QAbstractSocket::PauseModeflags QAbstractSocket::PauseModes

Это перечисление описывает поведение, когда сокет должен приостановить передачу данных. В настоящее время поддерживается только уведомление QSslSocket::sslErrors().

Это перечисление было введено или изменено в Qt 5.0.

Тип PauseModes является псевдонимом для QFlags<PauseMode>. Он хранит логическое ИЛИ сочетание значений PauseMode.

enum QAbstractSocket::SocketError

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

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

перечисление QAbstractSocket::SocketOption

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

Возможные значения для TypeOfServiceOption:

Это перечисление было добавлено или изменено в Qt 4.6.

См. также QAbstractSocket::setSocketOption() и QAbstractSocket::socketOption().

перечисление QAbstractSocket::SocketState

Это перечисление описывает различные состояния сокета.

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

enum QAbstractSocket::SocketType

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

См. также QAbstractSocket::socketType().

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

QAbstractSocket::QAbstractSocket(QAbstractSocket::SocketType socketType, QObject *parent)

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

См. также socketType(), QTcpSocket и QUdpSocket.

[virtual] QAbstractSocket::~QAbstractSocket()

Удаляет сокет.

void QAbstractSocket::abort()

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

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

[override virtual] bool QAbstractSocket::atEnd() const

Переопределено из QIODevice::atEnd().

Возвращает true если больше нет данных, доступных для чтения; в противном случае возвращает false.

Эта функция чаще всего используется при чтении данных из сокета в цикле. Например:

 // This slot is connected to QAbstractSocket::readyRead()
 void SocketClass::readyReadSlot()
 {
     while (!socket.atEnd()) {
         QByteArray data = socket.read(100);
         ....
     }
 }

См. также bytesAvailable() и readyRead().

bool QAbstractSocket::bind(const QHostAddress &address, quint16 port, QAbstractSocket::BindMode mode)

Связывает сокет с address на порту port, используя режим BindMode mode.

Для UDP-сокетов после привязки, сигнал QUdpSocket::readyRead() генерируется всякий раз, когда на указанный адрес и порт приходит UDP-датаграмма. Таким образом, эта функция полезна для написания UDP-серверов.

Для TCP-сокетов эта функция может использоваться для указания интерфейса, который будет использоваться для исходящего подключения, что полезно в случае нескольких сетевых интерфейсов.

По умолчанию сокет привязывается с помощью DefaultForPlatform BindMode. Если порт не указан, выбирается случайный порт.

При успехе функция возвращает true и сокет переходит в состояние BoundState; в противном случае возвращает false.

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

bool QAbstractSocket::bind(quint16 port, QAbstractSocket::BindMode mode)

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

Связывает сокет с QHostAddress:Any на порту port, используя режим BindMode mode.

По умолчанию сокет привязывается с помощью DefaultForPlatform BindMode. Если порт не указан, выбирается случайный порт.

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

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

Переопределено из QIODevice::bytesAvailable().

Возвращает количество входящих байтов, ожидающих чтения.

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

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

Переопределено из QIODevice::bytesToWrite().

Возвращает количество байтов, ожидающих записи. Байты записываются, когда управление возвращается в цикл обработки событий или когда вызывается flush().

См. также bytesAvailable() и flush().

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

Переопределено из QIODevice::canReadLine().

Возвращает true если строка данных может быть прочитана из сокета; в противном случае возвращает false.

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

[override virtual] void QAbstractSocket::close()

Переопределено из QIODevice::close().

Закрывает устройство ввода-вывода для сокета и вызывает disconnectFromHost() для закрытия подключения сокета.

См. QIODevice::close() для описания действий, которые происходят при закрытии устройства ввода-вывода.

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

[virtual] void QAbstractSocket::connectToHost(const QString &hostName, quint16 port, QIODevice::OpenMode openMode = ReadWrite, QAbstractSocket::NetworkLayerProtocol protocol = AnyIPProtocol)

Попытка подключения к hostName на заданном port. Параметр protocol может быть использован для указания сетевого протокола (например, IPv4 или IPv6).

Сокет открывается в заданном openMode и сначала переходит в состояние HostLookupState, затем выполняется поиск имени хоста hostName. Если поиск успешен, генерируется hostFound() и QAbstractSocket переходит в ConnectingState. Затем производится попытка подключиться к адресу или адресам, возвращённым результатом поиска. Наконец, если подключение установлено, QAbstractSocket переходит в ConnectedState и генерирует connected().

В любой момент сокет может генерировать error() для сигнализации об ошибке.

hostName может быть IP-адресом в строковом формате (например, "43.195.83.32") или именем хоста (например, "example.com"). QAbstractSocket выполнит поиск только при необходимости. port в родном порядке байтов.

См. также state(), peerName(), peerAddress(), peerPort() и waitForConnected().

[virtual] void QAbstractSocket::connectToHost(const QHostAddress &address, quint16 port, QIODevice::OpenMode openMode = ReadWrite)

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

Попытка подключения к address на порту port.

[signal] void QAbstractSocket::connected()

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

Примечание: На некоторых операционных системах сигнал connected() может генерироваться напрямую из вызова connectToHost() для подключений к localhost.

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

[virtual] void QAbstractSocket::disconnectFromHost()

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

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

[signal] void QAbstractSocket::disconnected()

Этот сигнал генерируется при разрыве соединения сокета.

Предупреждение: Если вам нужно удалить sender() этого сигнала в слоте, подключённом к нему, используйте функцию deleteLater().

См. также connectToHost(), disconnectFromHost() и abort().

QAbstractSocket::SocketError QAbstractSocket::error() const

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

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

[signal] void QAbstractSocket::error(QAbstractSocket::SocketError socketError)

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

Когда этот сигнал излучается, сокет может быть не готов к повторной попытке подключения. В этом случае попытки повторного подключения следует выполнять из цикла событий. Например, используйте QTimer::singleShot() с 0 в качестве таймаута.

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

Примечание: Сигнал error перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя функции Qt предоставляет удобную вспомогательную функцию для получения указателя функции, как показано в этом примере:

connect(abstractSocket, QOverload<QAbstractSocket::SocketError>::of(&QAbstractSocket::error),
    [=](QAbstractSocket::SocketError socketError){ /* ... */ });

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

bool QAbstractSocket::flush()

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

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

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

[signal] void QAbstractSocket::hostFound()

Этот сигнал излучается после вызова connectToHost(), если поиск хоста завершился успешно.

Примечание: Начиная с Qt 4.6.3, QAbstractSocket может излучать hostFound() непосредственно из вызова connectToHost(), так как результат DNS может быть кэширован.

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

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

Переопределено из QIODevice::isSequential().

bool QAbstractSocket::isValid() const

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

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

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

QHostAddress QAbstractSocket::localAddress() const

Возвращает адрес хоста локального сокета, если доступен; в противном случае возвращает QHostAddress::Null.

Как правило, это основной IP-адрес хоста, но может быть QHostAddress::LocalHost (127.0.0.1) для подключений к локальному хосту.

См. также localPort(), peerAddress() и setLocalAddress().

quint16 QAbstractSocket::localPort() const

Возвращает номер порта хоста (в порядке байтов системы) локального сокета, если доступен; в противном случае возвращает 0.

См. также localAddress(), peerPort() и setLocalPort().

QAbstractSocket::PauseModes QAbstractSocket::pauseMode() const

Возвращает режим приостановки этого сокета.

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

См. также setPauseMode() и resume().

QHostAddress QAbstractSocket::peerAddress() const

Возвращает адрес подключенного узла, если сокет находится в состоянии ConnectedState; в противном случае возвращает QHostAddress::Null.

См. также peerName(), peerPort(), localAddress() и setPeerAddress().

QString QAbstractSocket::peerName() const

Возвращает имя узла, заданное в connectToHost(), или пустую строку QString, если connectToHost() не был вызван.

См. также peerAddress(), peerPort() и setPeerName().

quint16 QAbstractSocket::peerPort() const

Возвращает порт подключенного узла, если сокет находится в состоянии ConnectedState; в противном случае возвращает 0.

См. также peerAddress(), localPort() и setPeerPort().

QNetworkProxy QAbstractSocket::proxy() const

Возвращает сетевой прокси для этого сокета. По умолчанию используется QNetworkProxy::DefaultProxy, что означает, что этот сокет будет запрашивать настройки прокси по умолчанию для приложения.

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

См. также setProxy(), QNetworkProxy и QNetworkProxyFactory.

[signal] void QAbstractSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

Этот сигнал может излучаться при использовании proxy, требующего аутентификации. Объект authenticator может быть заполнен необходимыми данными для разрешения аутентификации и продолжения подключения.

Примечание: Невозможно использовать QueuedConnection для подключения к этому сигналу, так как подключение завершится неудачей, если authenticator не был заполнен новой информацией к моменту возвращения сигнала.

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

См. также QAuthenticator и QNetworkProxy.

qint64 QAbstractSocket::readBufferSize() const

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

Размер буфера чтения 0 (по умолчанию) означает, что буфер не имеет ограничения по размеру, гарантируя, что данные не потеряются.

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

[override virtual protected] qint64 QAbstractSocket::readData(char *data, qint64 maxSize)

Переопределено из QIODevice::readData().

[override virtual protected] qint64 QAbstractSocket::readLineData(char *data, qint64 maxlen)

Переопределено из QIODevice::readLineData().

[virtual] void QAbstractSocket::resume()

Продолжает передачу данных по сокету. Этот метод следует использовать только после того, как сокет был приостановлен по уведомлениям и было получено уведомление. В настоящее время поддерживается только уведомление QSslSocket::sslErrors(). Вызов этого метода, если сокет не приостановлен, приводит к неопределенному поведению.

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

См. также pauseMode() и setPauseMode().

[protected] void QAbstractSocket::setLocalAddress(const QHostAddress &address)

Устанавливает адрес на локальной стороне соединения на address.

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

Обратите внимание, что эта функция не привязывает локальный адрес сокета до подключения (например, QAbstractSocket::bind()).

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

См. также localAddress(), setLocalPort() и setPeerAddress().

[protected] void QAbstractSocket::setLocalPort(quint16 port)

Устанавливает порт локальной стороны соединения в port.

Вы можете вызвать эту функцию в подклассе QAbstractSocket, чтобы изменить возвращаемое значение функции localPort() после установления соединения. Эта функция обычно используется для прокси-соединений для настройки виртуальных соединений.

Обратите внимание, что эта функция не связывает локальный порт сокета до подключения (например, QAbstractSocket::bind()).

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

См. также localPort(), localAddress(), setLocalAddress() и setPeerPort().

void QAbstractSocket::setPauseMode(QAbstractSocket::PauseModes pauseMode)

Управляет приостановкой при получении уведомления. Параметр pauseMode определяет условия, при которых сокет должен быть приостановлен. В настоящее время поддерживается только уведомление QSslSocket::sslErrors(). Если установлено значение PauseOnSslErrors, передача данных по сокету приостанавливается и должна быть явно возобновлена вызовом resume(). По умолчанию этот параметр установлен в PauseNever. Этот параметр необходимо задать перед подключением к серверу, в противном случае поведение будет неопределённым.

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

См. также pauseMode() и resume().

[protected] void QAbstractSocket::setPeerAddress(const QHostAddress &address)

Устанавливает адрес удалённой стороны соединения на address.

Вы можете вызвать эту функцию в подклассе QAbstractSocket, чтобы изменить возвращаемое значение функции peerAddress() после установления соединения. Эта функция обычно используется для прокси-соединений для настройки виртуальных соединений.

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

См. также peerAddress(), setPeerPort() и setLocalAddress().

[protected] void QAbstractSocket::setPeerName(const QString &name)

Устанавливает имя хоста удалённого узла на name.

Вы можете вызвать эту функцию в подклассе QAbstractSocket, чтобы изменить возвращаемое значение функции peerName() после установления соединения. Эта функция обычно используется для прокси-соединений для настройки виртуальных соединений.

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

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

[protected] void QAbstractSocket::setPeerPort(quint16 port)

Устанавливает порт удалённой стороны соединения на port.

Вы можете вызвать эту функцию в подклассе QAbstractSocket, чтобы изменить возвращаемое значение функции peerPort() после установления соединения. Эта функция обычно используется для прокси-соединений для настройки виртуальных соединений.

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

См. также peerPort(), setPeerAddress() и setLocalPort().

void QAbstractSocket::setProxy(const QNetworkProxy &networkProxy)

Устанавливает явное сетевое прокси для данного сокета на networkProxy.

Чтобы отключить использование прокси для данного сокета, используйте тип прокси QNetworkProxy::NoProxy:

socket->setProxy(QNetworkProxy::NoProxy);

Значение по умолчанию для прокси — QNetworkProxy::DefaultProxy, что означает, что сокет будет использовать настройки приложения: если прокси установлен с помощью QNetworkProxy::setApplicationProxy, он будет использовать его; в противном случае, если фабрика установлена с помощью QNetworkProxyFactory::setApplicationProxyFactory, он будет запрашивать эту фабрику с типом QNetworkProxyQuery::TcpSocket.

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

См. также proxy(), QNetworkProxy и QNetworkProxyFactory::queryProxy().

[virtual] void QAbstractSocket::setReadBufferSize(qint64 size)

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

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

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

Только QTcpSocket использует внутренний буфер QAbstractSocket; QUdpSocket вообще не использует никакой буферизации, а полагается на неявную буферизацию, предоставляемую операционной системой. Из-за этого вызов этой функции для QUdpSocket не оказывает никакого эффекта.

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

[virtual] bool QAbstractSocket::setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState socketState = ConnectedState, QIODevice::OpenMode openMode = ReadWrite)

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

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

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

[protected] void QAbstractSocket::setSocketError(QAbstractSocket::SocketError socketError)

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

См. также setSocketState() и setErrorString().

[virtual] void QAbstractSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

Устанавливает заданный параметр option на значение, описанное value.

Примечание: в Windows Runtime, QAbstractSocket::KeepAliveOption должен быть установлен до подключения к сокету.

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

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

[protected] void QAbstractSocket::setSocketState(QAbstractSocket::SocketState state)

Устанавливает состояние сокета на state.

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

[virtual] qintptr QAbstractSocket::socketDescriptor() const

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

Если сокет использует QNetworkProxy, возвращаемый дескриптор может быть непригоден для использования с функциями нативных сокетов.

Дескриптор сокета недоступен, когда QAbstractSocket находится в состоянии UnconnectedState.

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

[virtual] QVariant QAbstractSocket::socketOption(QAbstractSocket::SocketOption option)

Возвращает значение параметра option.

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

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

QAbstractSocket::SocketType QAbstractSocket::socketType() const

Возвращает тип сокета (TCP, UDP или другой).

См. также QTcpSocket и QUdpSocket.

QAbstractSocket::SocketState QAbstractSocket::state() const

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

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

[signal] void QAbstractSocket::stateChanged(QAbstractSocket::SocketState socketState)

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

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

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

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

Переопределено из QIODevice::waitForBytesWritten().

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

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

Примечание: Эта функция может случайным образом завершаться сбоем в Windows. При работе программного обеспечения в Windows рекомендуется использовать цикл событий и сигнал bytesWritten().

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

[virtual] bool QAbstractSocket::waitForConnected(int msecs = 30000)

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

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

socket->connectToHost("imap", 143);
if (socket->waitForConnected(1000))
    qDebug("Connected!");

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

Примечание: Эта функция может ожидать немного дольше, чем msecs, в зависимости от времени, необходимого для завершения поиска хоста.

Примечание: Несколько вызовов этой функции не накапливают время. Если функция ожидает истечения времени, процесс подключения будет прерван.

Примечание: Эта функция может случайным образом завершаться сбоем в Windows. При работе программного обеспечения в Windows рекомендуется использовать цикл событий и сигнал connected().

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

[virtual] bool QAbstractSocket::waitForDisconnected(int msecs = 30000)

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

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

socket->disconnectFromHost();
    if (socket->state() == QAbstractSocket::UnconnectedState ||
        socket->waitForDisconnected(1000))
        qDebug("Disconnected!");

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

Примечание: Эта функция может случайным образом завершаться сбоем в Windows. При работе программного обеспечения в Windows рекомендуется использовать цикл событий и сигнал disconnected().

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

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

Переопределено из QIODevice::waitForReadyRead().

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

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

Примечание: Эта функция может случайным образом завершаться сбоем в Windows. При работе программного обеспечения в Windows рекомендуется использовать цикл событий и сигнал readyRead().

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

[override virtual protected] qint64 QAbstractSocket::writeData(const char *data, qint64 size)

Переопределено из QIODevice::writeData().