QAbstractSocket Class

Documentación de las funciones miembro

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

Crea un nuevo socket abstracto de tipo socketType. El argumento parent se pasa al constructor de QObject.

Véase también socketType(), QTcpSocket, y QUdpSocket.

[virtual noexcept] QAbstractSocket::~QAbstractSocket()

Destruye el enchufe.

void QAbstractSocket::abort()

Aborta la conexión actual y reinicia el socket. A diferencia de disconnectFromHost(), esta función cierra inmediatamente el socket, descartando cualquier dato pendiente en el búfer de escritura.

Véase también disconnectFromHost() y close().

[virtual] bool QAbstractSocket::bind(const QHostAddress &address, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

Se vincula a address en el puerto port, utilizando el BindMode mode .

Para los sockets UDP, después del enlace, la señal QUdpSocket::readyRead() se emite cada vez que llega un datagrama UDP a la dirección y puerto especificados. Por lo tanto, esta función es útil para escribir servidores UDP.

Para sockets TCP, esta función se puede utilizar para especificar qué interfaz utilizar para una conexión saliente, lo que es útil en caso de múltiples interfaces de red.

Por defecto, el socket se vincula utilizando la dirección DefaultForPlatform BindMode . Si no se especifica un puerto, se elige un puerto aleatorio.

En caso de éxito, la función devuelve true y el socket entra en BoundState; en caso contrario devuelve false.

bool QAbstractSocket::bind(quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

Se enlaza a QHostAddress:Any en el puerto port, utilizando el BindMode mode .

Por defecto, el socket se enlaza utilizando DefaultForPlatform BindMode . Si no se especifica un puerto, se elige un puerto aleatorio.

[since 6.2] bool QAbstractSocket::bind(QHostAddress::SpecialAddress addr, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)

Se enlaza a la dirección especial addr en el puerto port, utilizando la dirección BindMode mode .

Por defecto, el socket se enlaza utilizando la dirección DefaultForPlatform BindMode . Si no se especifica un puerto, se elige un puerto aleatorio.

Esta función se introdujo en Qt 6.2.

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

Reimplementa: QIODevice::bytesAvailable() const.

Devuelve el número de bytes entrantes que están esperando ser leídos.

Véase también bytesToWrite() y read().

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

Reimplementa: QIODevice::bytesToWrite() const.

Devuelve el número de bytes que están esperando a ser escritos. Los bytes se escriben cuando el control vuelve al bucle de eventos o cuando se llama a flush().

Véase también bytesAvailable() y flush().

[override virtual] void QAbstractSocket::close()

Reimplementa: QIODevice::close().

Cierra el dispositivo de E/S para el socket y llama a disconnectFromHost() para cerrar la conexión del socket.

Ver QIODevice::close() para una descripción de las acciones que ocurren cuando se cierra un dispositivo de E/S.

Véase también abort().

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

Intenta establecer una conexión con hostName en la dirección port. El parámetro protocol puede utilizarse para especificar qué protocolo de red utilizar (por ejemplo, IPv4 o IPv6).

El socket se abre en el openMode dado y primero entra en HostLookupState, luego realiza una búsqueda de nombre de host en hostName. Si la búsqueda tiene éxito, se emite hostFound() y QAbstractSocket entra en ConnectingState. A continuación, intenta conectarse a la dirección o direcciones devueltas por la búsqueda. Finalmente, si se establece una conexión, QAbstractSocket entra en ConnectedState y emite connected().

En cualquier momento, el socket puede emitir errorOccurred() para indicar que se ha producido un error.

hostName puede ser una dirección IP en forma de cadena (por ejemplo, "43.195.83.32"), o puede ser un nombre de host (por ejemplo, "ejemplo.com"). QAbstractSocket hará una búsqueda sólo si es necesario. port está en orden nativo de bytes.

Véase también state(), peerName(), peerAddress(), peerPort() y waitForConnected().

void QAbstractSocket::connectToHost(const QHostAddress &address, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite)

Intenta establecer una conexión con address en el puerto port.

[signal] void QAbstractSocket::connected()

Esta señal se emite después de que se haya llamado a connectToHost() y se haya establecido con éxito una conexión.

Véase también connectToHost() y disconnected().

[virtual] void QAbstractSocket::disconnectFromHost()

Intenta cerrar el socket. Si hay datos pendientes esperando a ser escritos, QAbstractSocket entrará en ClosingState y esperará hasta que todos los datos hayan sido escritos. Finalmente, entrará en UnconnectedState y emitirá la señal disconnected().

Véase también connectToHost().

[signal] void QAbstractSocket::disconnected()

Esta señal se emite cuando la toma se ha desconectado.

Véase también connectToHost(), disconnectFromHost() y abort().

QAbstractSocket::SocketError QAbstractSocket::error() const

Devuelve el tipo de error que se produjo por última vez.

Véase también state() y errorString().

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

Esta señal se emite tras producirse un error. El parámetro socketError describe el tipo de error que se ha producido.

Cuando se emite esta señal, es posible que el socket no esté listo para un intento de reconexión. En ese caso, los intentos de reconexión deben hacerse desde el bucle de eventos. Por ejemplo, usa QChronoTimer::singleShot() con 0ns como tiempo de espera.

QAbstractSocket::SocketError no es un metatipo registrado, por lo que para conexiones en cola, tendrás que registrarlo con Q_DECLARE_METATYPE() y qRegisterMetaType().

Véase también error(), errorString(), y Creación de tipos Qt personalizados.

bool QAbstractSocket::flush()

Esta función escribe tanto como sea posible desde el búfer de escritura interno al socket de red subyacente, sin bloquear. Si se ha escrito algún dato, esta función devuelve true; en caso contrario devuelve false.

Llame a esta función si necesita que QAbstractSocket comience a enviar datos del buffer inmediatamente. El número de bytes escritos con éxito depende del sistema operativo. En la mayoría de los casos, no es necesario llamar a esta función, porque QAbstractSocket empezará a enviar datos automáticamente una vez que el control vuelva al bucle de eventos. En ausencia de un bucle de eventos, llame a waitForBytesWritten() en su lugar.

Véase también write() y waitForBytesWritten().

[signal] void QAbstractSocket::hostFound()

Esta señal se emite después de que connectToHost() haya sido llamado y la búsqueda de host haya tenido éxito.

Véase también connected().

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

Reimplementa: QIODevice::isSequential() const.

bool QAbstractSocket::isValid() const

Devuelve true si el socket es válido y está listo para su uso; en caso contrario devuelve false.

Véase también state().

QHostAddress QAbstractSocket::localAddress() const

Devuelve la dirección del host del socket local si está disponible; en caso contrario devuelve QHostAddress::Null.

Normalmente es la dirección IP principal del host, pero puede ser QHostAddress::LocalHost (127.0.0.1) para conexiones al host local.

Véase también localPort(), peerAddress() y setLocalAddress().

quint16 QAbstractSocket::localPort() const

Devuelve el número de puerto del host (en orden nativo de bytes) del socket local si está disponible; en caso contrario devuelve 0.

Véase también localAddress(), peerPort() y setLocalPort().

QAbstractSocket::PauseModes QAbstractSocket::pauseMode() const

Devuelve el modo de pausa de este socket.

Véase también setPauseMode() y resume().

QHostAddress QAbstractSocket::peerAddress() const

Devuelve la dirección del peer conectado si el socket está en ConnectedState; en caso contrario devuelve QHostAddress::Null.

Véase también peerName(), peerPort(), localAddress(), y setPeerAddress().

QString QAbstractSocket::peerName() const

Devuelve el nombre del par especificado por connectToHost(), o un QString vacío si no se ha llamado a connectToHost().

Véase también peerAddress(), peerPort() y setPeerName().

quint16 QAbstractSocket::peerPort() const

Devuelve el puerto del peer conectado si el socket está en ConnectedState; en caso contrario devuelve 0.

Véase también peerAddress(), localPort(), y setPeerPort().

QString QAbstractSocket::protocolTag() const

Devuelve la etiqueta de protocolo para este socket. Si la etiqueta de protocolo está definida, se pasa a QNetworkProxyQuery cuando se crea internamente para indicar la etiqueta de protocolo que se va a utilizar.

Véase también setProtocolTag() y QNetworkProxyQuery.

QNetworkProxy QAbstractSocket::proxy() const

Devuelve el proxy de red para este socket. Por defecto se utiliza QNetworkProxy::DefaultProxy, lo que significa que este socket consultará la configuración del proxy por defecto para la aplicación.

Ver también setProxy(), QNetworkProxy, y QNetworkProxyFactory.

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

Esta señal puede emitirse cuando se utiliza un proxy que requiere autenticación. El objeto authenticator puede entonces ser rellenado con los detalles requeridos para permitir la autenticación y continuar la conexión.

Véase también QAuthenticator y QNetworkProxy.

qint64 QAbstractSocket::readBufferSize() const

Devuelve el tamaño del búfer de lectura interno. Esto limita la cantidad de datos que el cliente puede recibir antes de llamar a read() o readAll().

Un tamaño de buffer de lectura de 0 (por defecto) significa que el buffer no tiene límite de tamaño, asegurando que no se pierda ningún dato.

Véase también setReadBufferSize() y read().

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

Reimplementa: QIODevice::readData(char *data, qint64 maxSize).

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

Reimplementa: QIODevice::readLineData(char *data, qint64 maxSize).

[virtual] void QAbstractSocket::resume()

Continúa la transferencia de datos en el socket. Este método sólo debe utilizarse después de que el socket haya sido configurado para pausarse ante notificaciones y se haya recibido una notificación. La única notificación soportada actualmente es QSslSocket::sslErrors(). Llamar a este método si el socket no está en pausa resulta en un comportamiento indefinido.

Véase también pauseMode() y setPauseMode().

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

Establece la dirección en el lado local de una conexión a address.

Puedes llamar a esta función en una subclase de QAbstractSocket para cambiar el valor de retorno de la función localAddress() después de que se haya establecido una conexión. Esta función es comúnmente utilizada por conexiones proxy para la configuración de conexiones virtuales.

Tenga en cuenta que esta función no vincula la dirección local del socket antes de una conexión (por ejemplo, QAbstractSocket::bind()).

Véase también localAddress(), setLocalPort(), y setPeerAddress().

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

Establece el puerto en el lado local de una conexión a port.

Puedes llamar a esta función en una subclase de QAbstractSocket para cambiar el valor de retorno de la función localPort() después de que se haya establecido una conexión. Esta función es comúnmente utilizada por conexiones proxy para la configuración de conexiones virtuales.

Tenga en cuenta que esta función no vincula el puerto local del socket antes de una conexión (por ejemplo, QAbstractSocket::bind()).

Véase también localPort(), localAddress(), setLocalAddress(), y setPeerPort().

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

Controla si se debe hacer una pausa al recibir una notificación. El parámetro pauseMode especifica las condiciones en las que el socket debe ser pausado. La única notificación soportada actualmente es QSslSocket::sslErrors(). Si se establece en PauseOnSslErrors, la transferencia de datos en el socket se pausará y necesitará ser activada explícitamente de nuevo llamando a resume(). Por defecto, esta opción está establecida a PauseNever. Esta opción debe ser llamada antes de conectarse al servidor, de lo contrario resultará en un comportamiento indefinido.

Véase también pauseMode() y resume().

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

Establece la dirección del lado remoto de la conexión en address.

Puedes llamar a esta función en una subclase de QAbstractSocket para cambiar el valor de retorno de la función peerAddress() después de que se haya establecido una conexión. Esta función es comúnmente utilizada por conexiones proxy para la configuración de conexiones virtuales.

Véase también peerAddress(), setPeerPort(), y setLocalAddress().

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

Establece el nombre de host del peer remoto en name.

Puedes llamar a esta función en una subclase de QAbstractSocket para cambiar el valor de retorno de la función peerName() después de que se haya establecido una conexión. Esta función es comúnmente utilizada por conexiones proxy para la configuración de conexiones virtuales.

Véase también peerName().

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

Establece el puerto del lado remoto de la conexión en port.

Puedes llamar a esta función en una subclase de QAbstractSocket para cambiar el valor de retorno de la función peerPort() después de que se haya establecido una conexión. Esta función es comúnmente utilizada por conexiones proxy para la configuración de conexiones virtuales.

Véase también peerPort(), setPeerAddress(), y setLocalPort().

void QAbstractSocket::setProtocolTag(const QString &tag)

Establece la etiqueta de protocolo para este socket en tag.

Véase también protocolTag().

void QAbstractSocket::setProxy(const QNetworkProxy &networkProxy)

Establece el proxy de red explícito para este socket en networkProxy.

Para desactivar el uso de un proxy para este socket, utiliza el tipo de proxy QNetworkProxy::NoProxy:

socket->setProxy(QNetworkProxy::NoProxy);

El valor por defecto para el proxy es QNetworkProxy::DefaultProxy, lo que significa que el socket utilizará la configuración de la aplicación: si se establece un proxy con QNetworkProxy::setApplicationProxy, utilizará ese; de lo contrario, si se establece una fábrica con QNetworkProxyFactory::setApplicationProxyFactory, consultará esa fábrica con el tipo QNetworkProxyQuery::TcpSocket.

Véase también proxy(), QNetworkProxy, y QNetworkProxyFactory::queryProxy().

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

Establece el tamaño del búfer de lectura interno de QAbstractSocket en size bytes.

Si el tamaño del búfer está limitado a un cierto tamaño, QAbstractSocket no almacenará más que este tamaño de datos. Excepcionalmente, un tamaño de buffer de 0 significa que el buffer de lectura es ilimitado y todos los datos entrantes son almacenados en el buffer. Este es el valor por defecto.

Esta opción es útil si sólo lees los datos en ciertos momentos (por ejemplo, en una aplicación de streaming en tiempo real) o si quieres proteger tu socket contra la recepción de demasiados datos, lo que eventualmente puede causar que tu aplicación se quede sin memoria.

Sólo QTcpSocket utiliza el buffer interno de QAbstractSocket; QUdpSocket no utiliza ningún buffer, sino que confía en el buffer implícito proporcionado por el sistema operativo. Por ello, llamar a esta función en QUdpSocket no tiene ningún efecto.

Véase también readBufferSize() y read().

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

Inicializa QAbstractSocket con el descriptor de socket nativo socketDescriptor. Devuelve true si socketDescriptor es aceptado como un descriptor de socket válido; en caso contrario devuelve false. El socket se abre en el modo especificado por openMode, y entra en el estado de socket especificado por socketState. Los buffers de lectura y escritura se limpian, descartando cualquier dato pendiente.

Nota: No es posible inicializar dos sockets abstractos con el mismo descriptor de socket nativo.

Véase también socketDescriptor().

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

Establece el tipo de error que se produjo por última vez en socketError.

Véase también setSocketState() y setErrorString().

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

Establece el option dado al valor descrito por value.

Véase también socketOption().

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

Establece el estado del socket en state.

Véase también state().

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

Reimplementa: QIODevice::skipData(qint64 maxSize).

[virtual] qintptr QAbstractSocket::socketDescriptor() const

Devuelve el descriptor de socket nativo del objeto QAbstractSocket si está disponible; en caso contrario devuelve -1.

Si el socket está usando QNetworkProxy, el descriptor devuelto puede no ser utilizable con funciones de socket nativas.

El descriptor de socket no está disponible cuando QAbstractSocket está en UnconnectedState.

Véase también setSocketDescriptor().

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

Devuelve el valor de la opción option.

Véase también setSocketOption().

QAbstractSocket::SocketType QAbstractSocket::socketType() const

Devuelve el tipo de socket (TCP, UDP u otro).

Véase también QTcpSocket y QUdpSocket.

QAbstractSocket::SocketState QAbstractSocket::state() const

Devuelve el estado del socket.

Véase también error().

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

Esta señal se emite cada vez que cambia el estado de QAbstractSocket. El parámetro socketState es el nuevo estado.

QAbstractSocket::SocketState no es un metatipo registrado, por lo que para conexiones en cola, tendrás que registrarlo con Q_DECLARE_METATYPE() y qRegisterMetaType().

Véase también state() y Creación de tipos Qt personalizados.

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

Reimplementa: QIODevice::waitForBytesWritten(int msecs).

Esta función se bloquea hasta que se ha escrito al menos un byte en el socket y se ha emitido la señal bytesWritten(). La función agotará el tiempo de espera después de msecs milisegundos; el tiempo de espera por defecto es de 30000 milisegundos.

La función devuelve true si se emite la señal bytesWritten(); en caso contrario devuelve false (si se ha producido un error o la operación ha expirado).

Véase también waitForReadyRead().

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

Espera hasta que el socket se conecta, hasta msecs milisegundos. Si se ha establecido la conexión, esta función devuelve true; en caso contrario devuelve false. En el caso de que devuelva false, puede llamar a error() para determinar la causa del error.

El siguiente ejemplo espera hasta un segundo a que se establezca una conexión:

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

Si msecs es -1, esta función no agotará el tiempo de espera.

Véase también connectToHost() y connected().

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

Espera hasta que el socket se haya desconectado, hasta msecs milisegundos. Si la conexión se ha desconectado con éxito, esta función devuelve true; en caso contrario devuelve false (si la operación ha expirado, si se ha producido un error, o si este QAbstractSocket ya está desconectado). En el caso de que devuelva false, puede llamar a error() para determinar la causa del error.

El siguiente ejemplo espera hasta un segundo a que se cierre una conexión:

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

Si msecs es -1, esta función no agotará el tiempo de espera.

Véase también disconnectFromHost() y close().

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

Reimplementa: QIODevice::waitForReadyRead(int msecs).

Esta función se bloquea hasta que hay nuevos datos disponibles para lectura y se ha emitido la señal readyRead(). La función expirará después de msecs milisegundos; el tiempo de espera por defecto es de 30000 milisegundos.

La función devuelve true si se emite la señal readyRead() y hay nuevos datos disponibles para su lectura; en caso contrario, devuelve false (si se ha producido un error o la operación ha expirado).

Véase también waitForBytesWritten().

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

Reimplementa: QIODevice::writeData(const char *data, qint64 maxSize).