QAbstractSocket Class
La clase `QAbstractSocket` proporciona la funcionalidad básica común a todos los tipos de sockets. Más información...
| Encabezado: | #include <QAbstractSocket> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Network) target_link_libraries(mytarget PRIVATE Qt6::Network) |
| qmake: | QT += network |
| Heredado de: | QIODevice |
| Heredado por: |
- Lista de todos los miembros, incluidos los heredados
- QAbstractSocket forma parte de la API de programación de redes.
Nota: Todas las funciones de esta clase son reentrantes.
Tipos públicos
| enum | BindFlag { ShareAddress, DontShareAddress, ReuseAddressHint, DefaultForPlatform } |
| flags | BindMode |
| enum | NetworkLayerProtocol { IPv4Protocol, IPv6Protocol, AnyIPProtocol, UnknownNetworkLayerProtocol } |
| enum | PauseMode { PauseNever, PauseOnSslErrors } |
| flags | PauseModes |
| enum | SocketError { ConnectionRefusedError, RemoteHostClosedError, HostNotFoundError, SocketAccessError, SocketResourceError, …, UnknownSocketError } |
| enum | SocketOption { LowDelayOption, KeepAliveOption, MulticastTtlOption, MulticastLoopbackOption, TypeOfServiceOption, …, KeepAliveCountOption } |
| enum | SocketState { UnconnectedState, HostLookupState, ConnectingState, ConnectedState, BoundState, …, ListeningState } |
| enum | SocketType { TcpSocket, UdpSocket, SctpSocket, UnknownSocketType } |
Funciones públicas
| QAbstractSocket(QAbstractSocket::SocketType socketType, QObject *parent) | |
| virtual | ~QAbstractSocket() |
| void | abort() |
| virtual bool | bind(const QHostAddress &address, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform) |
| bool | bind(quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform) |
(since 6.2) bool | bind(QHostAddress::SpecialAddress addr, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform) |
| virtual void | connectToHost(const QString &hostName, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite, QAbstractSocket::NetworkLayerProtocol protocol = AnyIPProtocol) |
| void | connectToHost(const QHostAddress &address, quint16 port, QIODeviceBase::OpenMode openMode = ReadWrite) |
| virtual void | disconnectFromHost() |
| QAbstractSocket::SocketError | error() const |
| bool | flush() |
| bool | isValid() const |
| QHostAddress | localAddress() const |
| quint16 | localPort() const |
| QAbstractSocket::PauseModes | pauseMode() const |
| QHostAddress | peerAddress() const |
| QString | peerName() const |
| quint16 | peerPort() const |
| QString | protocolTag() const |
| QNetworkProxy | proxy() const |
| qint64 | readBufferSize() const |
| virtual void | resume() |
| void | setPauseMode(QAbstractSocket::PauseModes pauseMode) |
| void | setProtocolTag(const QString &tag) |
| void | setProxy(const QNetworkProxy &networkProxy) |
| virtual void | setReadBufferSize(qint64 size) |
| virtual bool | setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState socketState = ConnectedState, QIODeviceBase::OpenMode openMode = ReadWrite) |
| virtual void | setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value) |
| virtual qintptr | socketDescriptor() const |
| virtual QVariant | socketOption(QAbstractSocket::SocketOption option) |
| QAbstractSocket::SocketType | socketType() const |
| QAbstractSocket::SocketState | state() const |
| virtual bool | waitForConnected(int msecs = 30000) |
| virtual bool | waitForDisconnected(int msecs = 30000) |
Funciones públicas reimplementadas
| virtual qint64 | bytesAvailable() const override |
| virtual qint64 | bytesToWrite() const override |
| virtual void | close() override |
| virtual bool | isSequential() const override |
| virtual bool | waitForBytesWritten(int msecs = 30000) override |
| virtual bool | waitForReadyRead(int msecs = 30000) override |
Señales
| void | connected() |
| void | disconnected() |
| void | errorOccurred(QAbstractSocket::SocketError socketError) |
| void | hostFound() |
| void | proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator) |
| void | stateChanged(QAbstractSocket::SocketState socketState) |
Funciones protegidas
| void | setLocalAddress(const QHostAddress &address) |
| void | setLocalPort(quint16 port) |
| void | setPeerAddress(const QHostAddress &address) |
| void | setPeerName(const QString &name) |
| void | setPeerPort(quint16 port) |
| void | setSocketError(QAbstractSocket::SocketError socketError) |
| void | setSocketState(QAbstractSocket::SocketState state) |
Funciones protegidas reimplementadas
| virtual qint64 | readData(char *data, qint64 maxSize) override |
| virtual qint64 | readLineData(char *data, qint64 maxlen) override |
| virtual qint64 | skipData(qint64 maxSize) override |
| virtual qint64 | writeData(const char *data, qint64 size) override |
Descripción detallada
QAbstractSocket es la clase base de QTcpSocket y QUdpSocket y contiene todas las funcionalidades comunes a estas dos clases. Si necesitas un socket, tienes dos opciones:
- Instanciar ` QTcpSocket ` o ` QUdpSocket`.
- Crear un descriptor de socket nativo, instanciar QAbstractSocket y llamar a setSocketDescriptor() para envolver el socket nativo.
TCP (Protocolo de Control de Transmisión) es un protocolo de transporte fiable, orientado a flujos y a conexiones. UDP (Protocolo de datagramas de usuario) es un protocolo no fiable, orientado a datagramas y sin conexión. En la práctica, esto significa que TCP es más adecuado para la transmisión continua de datos, mientras que el UDP, más ligero, puede utilizarse cuando la fiabilidad no es importante.
La API de QAbstractSocket unifica la mayoría de las diferencias entre ambos protocolos. Por ejemplo, aunque UDP no utiliza conexiones, ` connectToHost()` establece una conexión virtual para los sockets UDP, lo que permite utilizar `QAbstractSocket` prácticamente de la misma manera, independientemente del protocolo subyacente. Internamente, `QAbstractSocket` recuerda la dirección y el puerto pasados a ` connectToHost()`, y funciones como ` read()` y ` write()` utilizan estos valores.
En todo momento, QAbstractSocket tiene un estado (devuelto por state()). El estado inicial es UnconnectedState. Tras llamar a connectToHost(), el socket pasa primero a HostLookupState. Si se encuentra el host, QAbstractSocket pasa a ConnectingState y emite la señal hostFound(). Una vez establecida la conexión, pasa a ConnectedState y emite connected(). Si se produce un error en cualquier fase, se emite errorOccurred(). Cada vez que cambia el estado, se emite stateChanged(). Para mayor comodidad, isValid() devuelve true si el socket está listo para leer y escribir, pero hay que tener en cuenta que el estado del socket debe ser ConnectedState antes de que se pueda leer o escribir.
Para leer o escribir datos, llame a read() o write(), o utilice las funciones de conveniencia readLine() y readAll(). QAbstractSocket también hereda getChar(), putChar() y ungetChar() de QIODevice, que operan con bytes individuales. La señal bytesWritten() se emite cuando se han escrito datos en el socket. Ten en cuenta que Qt no limita el tamaño del búfer de escritura. Puedes supervisar su tamaño escuchando esta señal.
La señal « readyRead()» se emite cada vez que llega un nuevo bloque de datos. A continuación, « bytesAvailable()» devuelve el número de bytes disponibles para su lectura. Normalmente, se conectaría la señal « readyRead()» a una ranura (slot) y allí se leerían todos los datos disponibles. Si no se leen todos los datos de una sola vez, los datos restantes seguirán estando disponibles más tarde, y cualquier dato nuevo que llegue se añadirá al búfer de lectura interno de `QAbstractSocket`. Para limitar el tamaño del búfer de lectura, llame a ` setReadBufferSize()` ().
Para cerrar el socket, llama a ` disconnectFromHost()`. QAbstractSocket entra en el estado « QAbstractSocket::ClosingState ». Una vez que se han escrito todos los datos pendientes en el socket, QAbstractSocket cierra realmente el socket, entra en el estado « QAbstractSocket::UnconnectedState » y emite ` disconnected()`. Si desea abortar una conexión inmediatamente, descartando todos los datos pendientes, llame en su lugar a abort(). Si el host remoto cierra la conexión, QAbstractSocket emitirá errorOccurred(QAbstractSocket::RemoteHostClosedError), durante lo cual el estado del socket seguirá siendo ConnectedState, y a continuación se emitirá la señal disconnected().
El puerto y la dirección del par conectado se obtienen llamando a ` peerPort()` y ` peerAddress()`. ` peerName()` devuelve el nombre de host del par, tal y como se pasó a ` connectToHost()`. ` localPort()` y ` localAddress()` devuelven el puerto y la dirección del socket local.
QAbstractSocket proporciona un conjunto de funciones que suspenden el hilo de llamada hasta que se emitan determinadas señales. Estas funciones se pueden utilizar para implementar sockets bloqueantes:
- waitForConnected() bloquea hasta que se haya establecido una conexión.
- waitForReadyRead() se bloquea hasta que haya nuevos datos disponibles para su lectura.
- waitForBytesWritten() se bloquea hasta que se haya escrito una carga útil de datos en el socket.
- waitForDisconnected() se bloquea hasta que se haya cerrado la conexión.
Veamos un ejemplo:
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;
}Si waitForReadyRead() devuelve false, la conexión se ha cerrado o se ha producido un error.
La programación con un socket bloqueante es radicalmente diferente de la programación con un socket no bloqueante. Un socket bloqueante no requiere un bucle de eventos y suele dar lugar a un código más sencillo. Sin embargo, en una aplicación con interfaz gráfica de usuario (GUI), los sockets bloqueantes solo deben utilizarse en subprocesos que no sean de la GUI, para evitar que se cuelgue la interfaz de usuario. Consulta los ejemplos `fortuneclient ` y `blockingfortuneclient ` para obtener una visión general de ambos enfoques.
Nota: No recomendamos el uso de las funciones de bloqueo junto con señales. Se debe utilizar una de las dos posibilidades.
QAbstractSocket se puede utilizar con los operadores de flujo de QTextStream y QDataStream(operator<<() y operator>>()). Sin embargo, hay un aspecto que hay que tener en cuenta: debes asegurarte de que haya suficientes datos disponibles antes de intentar leerlos mediante operator>>().
Véase también QNetworkAccessManager y QTcpServer.
Documentación sobre tipos de miembros
enum QAbstractSocket::BindFlag
flags QAbstractSocket::BindMode
Esta enumeración describe los diferentes parámetros que se pueden pasar para modificar el comportamiento de QAbstractSocket::bind().
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::ShareAddress | 0x1 | Permite que otros servicios se vinculen a la misma dirección y puerto. Esto resulta útil cuando varios procesos comparten la carga de un único servicio al escuchar en la misma dirección y puerto (por ejemplo, un servidor web con varios escuchadores pre-forked puede mejorar considerablemente el tiempo de respuesta). Sin embargo, dado que se permite que cualquier servicio vuelva a vincularse, esta opción está sujeta a ciertas consideraciones de seguridad. Ten en cuenta que, al combinar esta opción con `ReuseAddressHint`, también permitirás que tu servicio vuelva a vincularse a una dirección compartida existente. En Unix, esto equivale a la opción de socket `SO_REUSEADDR`. En Windows, este es el comportamiento predeterminado, por lo que esta opción se ignora. |
QAbstractSocket::DontShareAddress | 0x2 | Asigna la dirección y el puerto de forma exclusiva, de modo que no se permita a ningún otro servicio volver a vincularse. Al pasar esta opción a ` QAbstractSocket::bind()`, se garantiza que, en caso de éxito, tu servicio sea el único que escuche en dicha dirección y puerto. No se permite a ningún servicio volver a vincularse, incluso si pasan `ReuseAddressHint`. Esta opción ofrece mayor seguridad que ShareAddress, pero en determinados sistemas operativos requiere ejecutar el servidor con privilegios de administrador. En Unix y macOS, no compartir es el comportamiento predeterminado al vincular una dirección y un puerto, por lo que esta opción se ignora. En Windows, esta opción utiliza la opción de socket SO_EXCLUSIVEADDRUSE. |
QAbstractSocket::ReuseAddressHint | 0x4 | Proporciona una indicación a ` QAbstractSocket ` de que debe intentar volver a vincular el servicio incluso si la dirección y el puerto ya están vinculados por otro socket. En Windows y Unix, esto equivale a la opción de socket `SO_REUSEADDR`. |
QAbstractSocket::DefaultForPlatform | 0x0 | La opción predeterminada para la plataforma actual. En Unix y macOS, equivale a (DontShareAddress + ReuseAddressHint), y en Windows, equivale a ShareAddress. |
El tipo BindMode es un typedef para QFlags<BindFlag>. Almacena una combinación OR de valores de BindFlag.
enum QAbstractSocket::NetworkLayerProtocol
Esta enumeración describe los valores de los protocolos de la capa de red utilizados en Qt Network.
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::IPv4Protocol | 0 | IPv4 |
QAbstractSocket::IPv6Protocol | 1 | IPv6 |
QAbstractSocket::AnyIPProtocol | 2 | IPv4 o IPv6 |
QAbstractSocket::UnknownNetworkLayerProtocol | -1 | Aparte de IPv4 e IPv6 |
Véase también QHostAddress::protocol().
enum QAbstractSocket::PauseMode
flags QAbstractSocket::PauseModes
Esta enumeración describe el comportamiento que debe adoptar el socket a la hora de suspender la transferencia de datos. La única notificación compatible actualmente es ` QSslSocket::sslErrors()`.
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::PauseNever | 0x0 | No detener la transferencia de datos en el socket. Este es el valor por defecto y coincide con el comportamiento de Qt 4. |
QAbstractSocket::PauseOnSslErrors | 0x1 | Pausa la transferencia de datos en el socket al recibir una notificación de error SSL. Es decir, ` QSslSocket::sslErrors()`. |
El tipo «PauseModes» es una definición de tipo para «QFlags<PauseMode>». Almacena una combinación OR de valores de «PauseMode».
enum QAbstractSocket::SocketError
Esta enumeración describe los errores de socket que pueden producirse.
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::ConnectionRefusedError | 0 | El nodo remoto rechazó la conexión (o se agotó el tiempo de espera). |
QAbstractSocket::RemoteHostClosedError | 1 | El host remoto cerró la conexión. Tenga en cuenta que el socket del cliente (es decir, este socket) se cerrará una vez que se haya enviado la notificación de cierre remoto. |
QAbstractSocket::HostNotFoundError | 2 | No se ha encontrado la dirección del host. |
QAbstractSocket::SocketAccessError | 3 | La operación del socket falló porque la aplicación carecía de los privilegios necesarios. |
QAbstractSocket::SocketResourceError | 4 | El sistema local se quedó sin recursos (por ejemplo, demasiados sockets). |
QAbstractSocket::SocketTimeoutError | 5 | La operación del socket superó el tiempo de espera. |
QAbstractSocket::DatagramTooLargeError | 6 | El datagrama superaba el límite del sistema operativo (que puede ser tan bajo como 8192 bytes). |
QAbstractSocket::NetworkError | 7 | Se produjo un error en la red (por ejemplo, el cable de red se desconectó accidentalmente). |
QAbstractSocket::AddressInUseError | 8 | La dirección especificada en ` QAbstractSocket::bind()` ya está en uso y se ha configurado como exclusiva. |
QAbstractSocket::SocketAddressNotAvailableError | 9 | La dirección especificada en la función ` QAbstractSocket::bind()` no pertenece al host. |
QAbstractSocket::UnsupportedSocketOperationError | 10 | El sistema operativo local no admite la operación de socket solicitada (por ejemplo, falta de compatibilidad con IPv6). |
QAbstractSocket::ProxyAuthenticationRequiredError | 12 | El socket está utilizando un proxy, y este requiere autenticación. |
QAbstractSocket::SslHandshakeFailedError | 13 | El protocolo de enlace SSL/TLS ha fallado, por lo que se ha cerrado la conexión (solo se utiliza en QSslSocket). |
QAbstractSocket::UnfinishedSocketOperationError | 11 | Utilizado únicamente por QAbstractSocketEngine. La última operación intentada aún no ha finalizado (sigue en curso en segundo plano). |
QAbstractSocket::ProxyConnectionRefusedError | 14 | No se ha podido contactar con el servidor proxy porque se denegó la conexión a dicho servidor |
QAbstractSocket::ProxyConnectionClosedError | 15 | La conexión con el servidor proxy se cerró de forma inesperada (antes de que se estableciera la conexión con el par final). |
QAbstractSocket::ProxyConnectionTimeoutError | 16 | Se ha agotado el tiempo de espera de la conexión con el servidor proxy o este ha dejado de responder durante la fase de autenticación. |
QAbstractSocket::ProxyNotFoundError | 17 | No se ha encontrado la dirección del proxy establecida con setProxy() (o el proxy de la aplicación). |
QAbstractSocket::ProxyProtocolError | 18 | La negociación de la conexión con el servidor proxy ha fallado, ya que no se ha podido interpretar la respuesta del servidor proxy. |
QAbstractSocket::OperationError | 19 | Se intentó realizar una operación mientras el socket se encontraba en un estado que no lo permitía. |
QAbstractSocket::SslInternalError | 20 | La biblioteca SSL utilizada ha notificado un error interno. Probablemente se deba a una instalación defectuosa o a una configuración incorrecta de la biblioteca. |
QAbstractSocket::SslInvalidUserDataError | 21 | Se proporcionaron datos no válidos (certificado, clave, cifrado, etc.) y su uso provocó un error en la biblioteca SSL. |
QAbstractSocket::TemporaryError | 22 | Se produjo un error temporal (por ejemplo, la operación se bloquearía y el socket es de tipo no bloqueante). |
QAbstractSocket::UnknownSocketError | -1 | Se ha producido un error no identificado. |
Véase también QAbstractSocket::error() y QAbstractSocket::errorOccurred().
enum QAbstractSocket::SocketOption
Esta enumeración representa las opciones que se pueden configurar en un socket. Si se desea, se pueden configurar tras haber recibido la señal « connected()» del socket o tras haber recibido un nuevo socket mediante « QTcpServer ».
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::LowDelayOption | 0 | Intenta optimizar el socket para una baja latencia. En el caso de un ` QTcpSocket `, esto establecería la opción `TCP_NODELAY` y desactivaría el algoritmo de Nagle. Establece este valor en 1 para habilitarlo. |
QAbstractSocket::KeepAliveOption | 1 | Establece este valor en 1 para habilitar la opción de socket SO_KEEPALIVE |
QAbstractSocket::MulticastTtlOption | 2 | Establece este valor en un número entero para configurar la opción de socket IP_MULTICAST_TTL (TTL para datagramas de multidifusión). |
QAbstractSocket::MulticastLoopbackOption | 3 | Establece este valor en 1 para habilitar la opción de socket IP_MULTICAST_LOOP (bucle de retorno de multidifusión). |
QAbstractSocket::TypeOfServiceOption | 4 | Esta opción no es compatible con Windows. Se corresponde con la opción de socket IP_TOS. Para conocer los valores posibles, consulte la tabla siguiente. |
QAbstractSocket::SendBufferSizeSocketOption | 5 | Establece el tamaño del búfer de envío del socket en bytes a nivel del sistema operativo. Esto se corresponde con la opción de socket SO_SNDBUF. Esta opción no afecta a los búferes de QIODevice ni de QAbstractSocket. Este valor de la enumeración se introdujo en Qt 5.3. |
QAbstractSocket::ReceiveBufferSizeSocketOption | 6 | Establece el tamaño del búfer de recepción del socket en bytes a nivel del sistema operativo. Esto se corresponde con la opción de socket SO_RCVBUF. Esta opción no afecta a los búferes ` QIODevice ` ni ` QAbstractSocket ` (véase setReadBufferSize()). Este valor de la enumeración se introdujo en Qt 5.3. |
QAbstractSocket::PathMtuSocketOption | 7 | Recupera el valor de la unidad máxima de transmisión de ruta (PMTU) del que tiene constancia actualmente la pila IP, si lo hay. Algunas pilas IP también permiten configurar la MTU para la transmisión. Este valor de enumeración se introdujo en Qt 5.11. |
QAbstractSocket::KeepAliveIdleOption | 8 | El tiempo, en segundos, que la conexión debe permanecer inactiva antes de que TCP comience a enviar sondas de mantenimiento de conexión si KeepAliveOption está habilitado. Este valor de enumeración se introdujo en Qt 6.11. |
QAbstractSocket::KeepAliveIntervalOption | 9 | El tiempo, en segundos, entre cada sondeo de mantenimiento de conexión, si KeepAliveOption está habilitado. Esta opción no es compatible con todos los sistemas operativos. Este valor de enumeración se introdujo en Qt 6.11. |
QAbstractSocket::KeepAliveCountOption | 10 | El número máximo de sondas de mantenimiento de conexión que se pueden enviar antes de que TCP interrumpa la conexión, si KeepAliveOption está habilitada. Esta opción no es compatible con todos los sistemas operativos. Este valor de enumeración se introdujo en Qt 6.11. |
Los valores posibles para TypeOfServiceOption son:
| Valor | Descripción |
|---|---|
| 224 | Control de red |
| 192 | Control de interredes |
| 160 | CRITIC/ECP |
| 128 | Anulación de Flash |
| 96 | Flash |
| 64 | Inmediato |
| 32 | Prioritario |
| 0 | Rutina |
Véase también QAbstractSocket::setSocketOption() y QAbstractSocket::socketOption().
enum QAbstractSocket::SocketState
Esta enumeración describe los diferentes estados en los que puede encontrarse un socket.
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::UnconnectedState | 0 | El socket no está conectado. |
QAbstractSocket::HostLookupState | 1 | El socket está realizando una búsqueda de nombre de host. |
QAbstractSocket::ConnectingState | 2 | El socket ha comenzado a establecer una conexión. |
QAbstractSocket::ConnectedState | 3 | Se ha establecido una conexión. |
QAbstractSocket::BoundState | 4 | El socket está vinculado a una dirección y un puerto. |
QAbstractSocket::ClosingState | 6 | El socket está a punto de cerrarse (puede que aún haya datos pendientes de escribir). |
QAbstractSocket::ListeningState | 5 | Solo para uso interno. |
Véase también QAbstractSocket::state().
enum QAbstractSocket::SocketType
Esta enumeración describe el protocolo de la capa de transporte.
| Constante | Valor | Descripción |
|---|---|---|
QAbstractSocket::TcpSocket | 0 | TCP |
QAbstractSocket::UdpSocket | 1 | UDP |
QAbstractSocket::SctpSocket | 2 | SCTP |
QAbstractSocket::UnknownSocketType | -1 | Aparte de TCP, UDP y SCTP |
Véase también QAbstractSocket::socketType().
Documentación de funciones de 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()
Elimina el socket.
void QAbstractSocket::abort()
Interrumpe la conexión actual y restablece el socket. A diferencia de ` disconnectFromHost()`, esta función cierra inmediatamente el socket, descartando cualquier dato pendiente en el búfer de escritura.
Véanse 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 .
En el caso de los sockets UDP, tras el enlace, se emite la señal QUdpSocket::readyRead() cada vez que llega un datagrama UDP a la dirección y el puerto especificados. Por lo tanto, esta función resulta útil para escribir servidores UDP.
En el caso de los sockets TCP, esta función puede utilizarse para especificar qué interfaz se debe utilizar para una conexión saliente, lo cual resulta útil cuando hay varias interfaces de red.
Por defecto, el socket se vincula utilizando DefaultForPlatform BindMode . Si no se especifica ningún puerto, se elige uno aleatorio.
Si la operación se realiza correctamente, la función devuelve « true » y el socket pasa al estado « BoundState »; en caso contrario, devuelve « false ».
bool QAbstractSocket::bind(quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)
Se vincula a QHostAddress:Any en el puerto port, utilizando el BindMode mode .
Por defecto, el socket se vincula utilizando DefaultForPlatform BindMode . Si no se especifica ningún puerto, se elige uno aleatorio.
Esta es una función sobrecargada.
[since 6.2] bool QAbstractSocket::bind(QHostAddress::SpecialAddress addr, quint16 port = 0, QAbstractSocket::BindMode mode = DefaultForPlatform)
Se vincula a la dirección especial addr en el puerto port, utilizando el BindMode mode .
Por defecto, el socket se vincula utilizando DefaultForPlatform BindMode . Si no se especifica un puerto, se elige uno aleatorio.
Esta es una función sobrecargada.
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 a la espera de 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 a la espera de 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 del socket y llama a disconnectFromHost() para cerrar la conexión del socket.
Consulte QIODevice::close() para obtener una descripción de las acciones que se producen al cerrar 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 indicada. El parámetro protocol permite especificar qué protocolo de red se debe utilizar (por ejemplo, IPv4 o IPv6).
El socket se abre en el openMode especificado y, en primer lugar, accede a HostLookupState; a continuación, realiza una búsqueda del nombre de host de hostName. Si la búsqueda tiene éxito, se emite hostFound() y QAbstractSocket accede a ConnectingState. A continuación, intenta conectarse a la dirección o direcciones devueltas por la búsqueda. Por último, si se establece una conexión, QAbstractSocket accede a 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 formato de cadena (p. ej., «43.195.83.32») o un nombre de host (p. ej., «example.com»). QAbstractSocket solo realizará una consulta si es necesario. port está en orden de bytes nativo.
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.
Se trata de una función sobrecargada.
[signal] void QAbstractSocket::connected()
Esta señal se emite después de que se haya llamado a ` connectToHost()` y se haya establecido correctamente una conexión.
Nota: En algunos sistemas operativos, la señal connected() puede emitirse directamente desde la llamada a connectToHost() para conexiones al localhost.
Véanse también ` connectToHost()` y ` disconnected()`.
[virtual] void QAbstractSocket::disconnectFromHost()
Intenta cerrar el socket. Si hay datos pendientes de escribir, « QAbstractSocket » entrará en « ClosingState » y esperará hasta que se hayan escrito todos los datos. 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 se ha desconectado el conector.
Advertencia: Si necesitas eliminar la llamada a ` sender()` de esta señal en un slot conectado a ella, utiliza la función ` deleteLater()`.
Véase también connectToHost(), disconnectFromHost() y abort().
QAbstractSocket::SocketError QAbstractSocket::error() const
Devuelve el tipo de error que se ha producido 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 realizarse desde el bucle de eventos. Por ejemplo, utiliza QChronoTimer::singleShot() con 0 ns como tiempo de espera.
QAbstractSocket::SocketError no es un metatipo registrado, por lo que, para las 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 todo lo que sea posible desde el búfer de escritura interno al socket de red subyacente, sin bloquearse. Si se han escrito datos, esta función devuelve « true »; en caso contrario, devuelve «false».
Llama a esta función si necesitas que QAbstractSocket comience a enviar los datos almacenados en el búfer de inmediato. 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, ya que QAbstractSocket comenzará a enviar datos automáticamente en cuanto el control vuelva al bucle de eventos. Si no hay un bucle de eventos, llama en su lugar a waitForBytesWritten().
Véase también write() y waitForBytesWritten().
[signal] void QAbstractSocket::hostFound()
Esta señal se emite después de que se haya llamado a connectToHost() y la búsqueda del host se haya realizado con éxito.
Nota: A partir de Qt 4.6.3, ` QAbstractSocket ` puede emitir `hostFound()` directamente desde la llamada a ` connectToHost()`, ya que el resultado del DNS podría haberse almacenado en caché.
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 ».
Nota: El estado del socket debe ser ConnectedState antes de que se pueda leer o escribir.
Véase también state().
QHostAddress QAbstractSocket::localAddress() const
Devuelve la dirección del host del socket local, si está disponible; de lo contrario, devuelve QHostAddress::Null.
Normalmente se trata de la dirección IP principal del host, pero puede ser QHostAddress::LocalHost (127.0.0.1) en el caso de conexiones al host local.
Véanse también localPort(), peerAddress() y setLocalAddress().
quint16 QAbstractSocket::localPort() const
Devuelve el número de puerto del host (en orden de bytes nativo) 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 par conectado si el socket está en modo « ConnectedState »; en caso contrario, devuelve « QHostAddress::Null ».
Véanse también peerName(), peerPort(), localAddress() y setPeerAddress().
QString QAbstractSocket::peerName() const
Devuelve el nombre del par tal y como se especifica mediante connectToHost(), o un objeto 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 interlocutor 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 de 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 debe utilizar.
Véanse también setProtocolTag() y QNetworkProxyQuery.
QNetworkProxy QAbstractSocket::proxy() const
Devuelve el proxy de red de este socket. Por defecto se utiliza QNetworkProxy::DefaultProxy, lo que significa que este socket consultará la configuración predeterminada del proxy de la aplicación.
Véase también setProxy(), QNetworkProxy y QNetworkProxyFactory.
[signal] void QAbstractSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)
Esta señal puede emitirse cuando se utiliza una conexión en cola ( proxy ) que requiere autenticación. A continuación, se puede completar el objeto « authenticator » con los datos necesarios para permitir la autenticación y continuar con la conexión.
Nota: Noes posible utilizar una QueuedConnection para conectarse a esta señal, ya que la conexión fallará si no se ha introducido la información actualizada en el autenticador cuando la señal vuelva.
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 búfer de lectura de 0 (el valor por defecto) significa que el búfer no tiene límite de tamaño, lo que garantiza que no se pierdan datos.
Véanse 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 solo debe utilizarse después de que el socket se haya configurado para pausarse ante las notificaciones y se haya recibido una notificación. La única notificación compatible actualmente es QSslSocket::sslErrors(). Llamar a este método si el socket no está en pausa da lugar a un comportamiento indefinido.
Véanse también pauseMode() y setPauseMode().
[protected] void QAbstractSocket::setLocalAddress(const QHostAddress &address)
Establece la dirección del lado local de una 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 ` localAddress()` una vez establecida la conexión. Esta característica se utiliza habitualmente en conexiones proxy para la configuración de conexiones virtuales.
Ten en cuenta que esta función no vincula la dirección local del socket antes de establecer una conexión (p. ej., ` QAbstractSocket::bind()`).
Véanse también localAddress(), setLocalPort() y setPeerAddress().
[protected] void QAbstractSocket::setLocalPort(quint16 port)
Establece el puerto del lado local de una conexión a port.
Puedes llamar a esta función en una subclase de ` QAbstractSocket ` para modificar el valor de retorno de la función ` localPort()` una vez establecida la conexión. Esta característica se utiliza habitualmente en conexiones proxy para la configuración de conexiones virtuales.
Ten en cuenta que esta función no vincula el puerto local del socket antes de una conexión (por ejemplo, ` QAbstractSocket::bind()`).
Véanse también localPort(), localAddress(), setLocalAddress() y setPeerPort().
void QAbstractSocket::setPauseMode(QAbstractSocket::PauseModes pauseMode)
Determina si se debe pausar la aplicación al recibir una notificación. El parámetro « pauseMode » especifica las condiciones en las que se debe pausar el socket. La única notificación compatible actualmente es QSslSocket::sslErrors(). Si se establece en PauseOnSslErrors, la transferencia de datos en el socket se detendrá y deberá reactivarse explícitamente llamando a resume(). Por defecto, esta opción está establecida en PauseNever. Esta opción debe llamarse antes de conectarse al servidor; de lo contrario, se producirá un comportamiento indefinido.
Véase también pauseMode() y resume().
[protected] void QAbstractSocket::setPeerAddress(const QHostAddress &address)
Establece la dirección del extremo remoto de la conexión en address.
Puedes llamar a esta función en una subclase de ` QAbstractSocket ` para modificar el valor de retorno de la función ` peerAddress()` una vez establecida la conexión. Esta característica se utiliza habitualmente en 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 par remoto en name.
Puedes llamar a esta función en una subclase de ` QAbstractSocket ` para modificar el valor de retorno de la función ` peerName()` una vez establecida la conexión. Esta característica se utiliza habitualmente en conexiones proxy para la configuración de conexiones virtuales.
Véase también peerName().
[protected] void QAbstractSocket::setPeerPort(quint16 port)
Establece el puerto del extremo remoto de la conexión en port.
Puedes llamar a esta función en una subclase de ` QAbstractSocket ` para modificar el valor de retorno de la función ` peerPort()` una vez establecida la conexión. Esta característica se utiliza habitualmente en 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 de 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 predeterminado del proxy es « QNetworkProxy::DefaultProxy », lo que significa que el socket utilizará la configuración de la aplicación: si se ha configurado un proxy con « QNetworkProxy::setApplicationProxy », utilizará ese; de lo contrario, si se ha configurado una fábrica con « QNetworkProxyFactory::setApplicationProxyFactory », consultará a 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 se limita a un valor determinado, QAbstractSocket no almacenará en el búfer más datos que ese tamaño. Excepcionalmente, un tamaño de búfer igual a 0 significa que el búfer de lectura es ilimitado y se almacenan en él todos los datos entrantes. Este es el valor por defecto.
Esta opción resulta útil si solo se leen los datos en determinados momentos (por ejemplo, en una aplicación de transmisión en tiempo real) o si se desea proteger el socket para que no reciba demasiados datos, lo que podría acabar provocando que la aplicación se quedara sin memoria.
Solo QTcpSocket utiliza el búfer interno de QAbstractSocket; QUdpSocket no utiliza ningún tipo de almacenamiento en búfer, sino que se basa en el almacenamiento implícito que proporciona el sistema operativo. Por este motivo, 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 ` se acepta como un descriptor de socket válido; en caso contrario, devuelve ` false`. El socket se abre en el modo especificado por ` openMode` y pasa al estado de socket especificado por ` socketState`. Los búferes de lectura y escritura se vacían, 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 ha producido por última vez en ` socketError`.
Véase también setSocketState() y setErrorString().
[virtual] void QAbstractSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)
Establece el socket dado ( option ) en el valor descrito en value.
Nota: Dado que las opciones se configuran en un socket interno, solo se aplican si dicho socket se ha creado. Solo se garantiza que esto haya ocurrido tras una llamada a bind(), o cuando se haya emitido connected().
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 utiliza « QNetworkProxy », es posible que el descriptor devuelto no sea compatible con las funciones nativas de socket.
El descriptor de socket no está disponible cuando ` QAbstractSocket ` se encuentra 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 indica el nuevo estado.
QAbstractSocket::SocketState no es un metatipo registrado, por lo que, para las 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 permanece bloqueada hasta que se haya escrito al menos un byte en el socket y se haya emitido la señal bytesWritten(). La función agotará el tiempo de espera tras msecs milisegundos; el tiempo de espera por defecto es de 30 000 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 se ha agotado el tiempo de espera de la operación).
Nota: Esta función puede fallar de forma aleatoria en Windows. Considera la posibilidad de utilizar el bucle de eventos y la señal bytesWritten() si tu software se va a ejecutar en Windows.
Véase también ` waitForReadyRead()`.
[virtual] bool QAbstractSocket::waitForConnected(int msecs = 30000)
Espera a que el socket se conecte, durante un máximo de 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, se 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 tendrá límite de tiempo.
Nota: Esta función puede tardar un poco más que msecs, dependiendo del tiempo que se tarde en completar la búsqueda del host.
Nota: Las llamadasmúltiples a esta función no acumulan el tiempo. Si la función agota el tiempo de espera, se interrumpirá el proceso de conexión.
Nota: Esta función puede fallar aleatoriamente en Windows. Considera la posibilidad de utilizar el bucle de eventos y la señal ` connected()` si tu software se va a ejecutar en Windows.
Véase también connectToHost() y connected().
[virtual] bool QAbstractSocket::waitForDisconnected(int msecs = 30000)
Espera a que el socket se haya desconectado, hasta un máximo de msecs milisegundos. Si la conexión se ha desconectado correctamente, esta función devuelve true; en caso contrario, devuelve false (si se ha agotado el tiempo de espera de la operación, si se ha producido un error o si este QAbstractSocket ya está desconectado). En el caso de que devuelva false, se 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 tendrá límite de tiempo.
Nota: Esta función puede fallar de forma aleatoria en Windows. Considera la posibilidad de utilizar el bucle de eventos y la señal disconnected() si tu software se va a ejecutar en Windows.
Véase también disconnectFromHost() y close().
[override virtual] bool QAbstractSocket::waitForReadyRead(int msecs = 30000)
Reimplementa: ` QIODevice::waitForReadyRead(int msecs)`.
Esta función permanece bloqueada hasta que haya nuevos datos disponibles para su lectura y se haya emitido la señal readyRead(). La función agotará el tiempo de espera tras msecs milisegundos; el tiempo de espera predeterminado es de 30 000 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 se ha agotado el tiempo de espera de la operación).
Nota: Esta función puede fallar de forma aleatoria en Windows. Considera la posibilidad de utilizar el bucle de eventos y la señal readyRead() si tu software se va a ejecutar en Windows.
Véase también waitForBytesWritten().
[override virtual protected] qint64 QAbstractSocket::writeData(const char *data, qint64 size)
Reimplementa: QIODevice::writeData(const char *data, qint64 maxSize).
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.