QUdpSocket Class
La clase QUdpSocket proporciona un socket UDP. Más información...
| Encabezado: | #include <QUdpSocket> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Network) target_link_libraries(mytarget PRIVATE Qt6::Network) |
| qmake: | QT += network |
| Heredado de: | QAbstractSocket |
- Lista de todos los miembros, incluidos los heredados
- QUdpSocket forma parte de la API de programación de redes.
Nota: Todas las funciones de esta clase son reentrantes.
Funciones públicas
| QUdpSocket(QObject *parent = nullptr) | |
| virtual | ~QUdpSocket() |
| bool | hasPendingDatagrams() const |
| bool | joinMulticastGroup(const QHostAddress &groupAddress) |
| bool | joinMulticastGroup(const QHostAddress &groupAddress, const QNetworkInterface &iface) |
| bool | leaveMulticastGroup(const QHostAddress &groupAddress) |
| bool | leaveMulticastGroup(const QHostAddress &groupAddress, const QNetworkInterface &iface) |
| QNetworkInterface | multicastInterface() const |
| qint64 | pendingDatagramSize() const |
| qint64 | readDatagram(char *data, qint64 maxSize, QHostAddress *address = nullptr, quint16 *port = nullptr) |
| QNetworkDatagram | receiveDatagram(qint64 maxSize = -1) |
| void | setMulticastInterface(const QNetworkInterface &iface) |
| qint64 | writeDatagram(const char *data, qint64 size, const QHostAddress &address, quint16 port) |
| qint64 | writeDatagram(const QNetworkDatagram &datagram) |
| qint64 | writeDatagram(const QByteArray &datagram, const QHostAddress &host, quint16 port) |
Descripción detallada
UDP (Protocolo de datagramas de usuario) es un protocolo ligero, no fiable, orientado a datagramas y sin conexión. Se puede utilizar cuando la fiabilidad no es importante. QUdpSocket es una subclase de QAbstractSocket que permite enviar y recibir datagramas UDP.
La forma más habitual de utilizar esta clase es vincularse a una dirección y un puerto mediante ` bind()`, y a continuación llamar a ` writeDatagram()` y ` readDatagram()` / ` receiveDatagram()` para transferir datos. Si desea utilizar las funciones estándar de ` QIODevice `, como ` read()`, ` readLine()`, ` write()`, etc., primero debe conectar el socket directamente a un par llamando a ` connectToHost()`.
El socket emite la señal bytesWritten() cada vez que se escribe un datagrama en la red. Si solo se desea enviar datagramas, no es necesario llamar a bind().
La señal « readyRead()» se emite cada vez que llegan datagramas. En ese caso, « hasPendingDatagrams()» devuelve « true ». Llama a « pendingDatagramSize()» para obtener el tamaño del primer datagrama pendiente, y a « readDatagram()» o « receiveDatagram()» para leerlo.
Nota: Un datagrama entrante debe leerse al recibir la señal readyRead(), de lo contrario, esta señal no se emitirá para el siguiente datagrama.
Ejemplo:
void Server::initSocket()
{
udpSocket = new QUdpSocket(this);
udpSocket->bind(QHostAddress::LocalHost, 7755);
connect(udpSocket, &QUdpSocket::readyRead,
this, &Server::readPendingDatagrams);
}
void Server::readPendingDatagrams()
{
while (udpSocket->hasPendingDatagrams()) {
QNetworkDatagram datagram = udpSocket->receiveDatagram();
processTheDatagram(datagram);
}
}QUdpSocket también admite la multidifusión UDP. Utiliza joinMulticastGroup() y leaveMulticastGroup() para controlar la pertenencia a grupos, y QAbstractSocket::MulticastTtlOption y QAbstractSocket::MulticastLoopbackOption para configurar las opciones de TTL y de socket de bucle cerrado. Utiliza setMulticastInterface() para controlar la interfaz de salida de los datagramas de multidifusión, y multicastInterface() para consultarla.
Con QUdpSocket, también se puede establecer una conexión virtual con un servidor UDP mediante connectToHost() y, a continuación, utilizar read() y write() para intercambiar datagramas sin especificar el receptor de cada datagrama.
Los ejemplos «Broadcast Sender», «Broadcast Receiver», «Multicast Sender» y «Multicast Receiver» ilustran cómo utilizar QUdpSocket en aplicaciones.
Véase también QTcpSocket y QNetworkDatagram.
Documentación de las funciones de miembro
[explicit] QUdpSocket::QUdpSocket(QObject *parent = nullptr)
Crea un objeto QUdpSocket.
parent Se pasa al constructor de QObject.
Véase también socketType().
[virtual noexcept] QUdpSocket::~QUdpSocket()
Elimina el socket y, si es necesario, cierra la conexión.
Véase también close().
bool QUdpSocket::hasPendingDatagrams() const
Devuelve ` true ` si hay al menos un datagrama pendiente de lectura; en caso contrario, devuelve ` false`.
Véase también pendingDatagramSize() y readDatagram().
bool QUdpSocket::joinMulticastGroup(const QHostAddress &groupAddress)
Se une al grupo de multidifusión especificado por groupAddress en la interfaz predeterminada elegida por el sistema operativo. El socket debe estar en estado «BoundState»; de lo contrario, se produce un error.
Ten en cuenta que, si intentas unirte a un grupo IPv4, tu socket no debe estar vinculado mediante IPv6 (ni en modo dual, utilizando QHostAddress::Any). En su lugar, debes utilizar QHostAddress::AnyIPv4.
Esta función devuelve true si se ejecuta correctamente; de lo contrario, devuelve false y establece el error del socket en consecuencia.
Nota: No todos los sistemas operativos admitenla incorporación a grupos de multidifusión IPv6 sin especificar una interfaz. Considera la posibilidad de utilizar la sobrecarga en la que se especifica la interfaz.
Véase también leaveMulticastGroup().
bool QUdpSocket::joinMulticastGroup(const QHostAddress &groupAddress, const QNetworkInterface &iface)
Se une a la dirección de grupo de multidifusión groupAddress en la interfaz iface.
Esta es una función sobrecargada.
Véase también leaveMulticastGroup().
bool QUdpSocket::leaveMulticastGroup(const QHostAddress &groupAddress)
Abandona el grupo de multidifusión especificado por groupAddress en la interfaz predeterminada elegida por el sistema operativo. El socket debe estar en estado «BoundState»; de lo contrario, se produce un error.
Esta función devuelve ` true ` si se ejecuta correctamente; de lo contrario, devuelve ` false ` y establece el error del socket en consecuencia.
Nota: Esta función debe invocarse con los mismos argumentos que se pasaron a joinMulticastGroup().
Véase también joinMulticastGroup().
bool QUdpSocket::leaveMulticastGroup(const QHostAddress &groupAddress, const QNetworkInterface &iface)
Abandona el grupo de multidifusión especificado por « groupAddress » en la interfaz « iface ».
Nota: Esta función debe invocarse con los mismos argumentos que se pasaron a joinMulticastGroup().
Se trata de una función sobrecargada.
Véase también joinMulticastGroup().
QNetworkInterface QUdpSocket::multicastInterface() const
Devuelve la interfaz de salida para los datagramas de multidifusión. Esto se corresponde con la opción de socket IP_MULTICAST_IF para sockets IPv4 y con la opción de socket IPV6_MULTICAST_IF para sockets IPv6. Si no se ha establecido previamente ninguna interfaz, esta función devuelve un valor no válido QNetworkInterface. El socket debe estar en estado BoundState; de lo contrario, se devuelve un valor no válido QNetworkInterface.
Véase también setMulticastInterface().
qint64 QUdpSocket::pendingDatagramSize() const
Devuelve el tamaño del primer datagrama UDP pendiente. Si no hay ningún datagrama disponible, esta función devuelve -1.
Véanse también hasPendingDatagrams() y readDatagram().
qint64 QUdpSocket::readDatagram(char *data, qint64 maxSize, QHostAddress *address = nullptr, quint16 *port = nullptr)
Recibe un datagrama de un tamaño máximo de maxSize bytes y lo almacena en data. La dirección de host y el puerto del remitente se almacenan en *address y *port (a menos que los punteros sean nullptr).
Devuelve el tamaño del datagrama si la operación se realiza correctamente; en caso contrario, devuelve -1.
Si maxSize es demasiado pequeño, se perderá el resto del datagrama. Para evitar la pérdida de datos, llama a pendingDatagramSize() para determinar el tamaño del datagrama pendiente antes de intentar leerlo. Si maxSize es 0, el datagrama se descartará.
Véase también writeDatagram(), hasPendingDatagrams() y pendingDatagramSize().
QNetworkDatagram QUdpSocket::receiveDatagram(qint64 maxSize = -1)
Recibe un datagrama de un tamaño máximo de maxSize bytes y lo devuelve en el objeto QNetworkDatagram, junto con la dirección de host y el puerto del remitente. Si es posible, esta función también intentará determinar la dirección de destino del datagrama, el puerto y el número de saltos en el momento de la recepción.
En caso de fallo, devuelve un ` QNetworkDatagram ` que indica ` not valid`.
Si maxSize es demasiado pequeño, se perderá el resto del datagrama. Si maxSize es 0, el datagrama se descartará. Si maxSize es -1 (el valor predeterminado), esta función intentará leer el datagrama completo.
Véanse también writeDatagram(), hasPendingDatagrams() y pendingDatagramSize().
void QUdpSocket::setMulticastInterface(const QNetworkInterface &iface)
Establece la interfaz de salida para los datagramas de multidifusión en la interfaz iface. Esto se corresponde con la opción de socket IP_MULTICAST_IF para los sockets IPv4 y con la opción de socket IPV6_MULTICAST_IF para los sockets IPv6. El socket debe estar en estado «BoundState»; de lo contrario, esta función no realiza ninguna acción.
Véanse también multicastInterface(), joinMulticastGroup() y leaveMulticastGroup().
qint64 QUdpSocket::writeDatagram(const char *data, qint64 size, const QHostAddress &address, quint16 port)
Envía el datagrama con el tamaño size a la dirección de data address en el puerto port. Devuelve el número de bytes enviados si la operación se realiza con éxito; en caso contrario, devuelve -1.
Los datagramas siempre se escriben como un único bloque. El tamaño máximo de un datagrama depende en gran medida de la plataforma, pero puede ser tan reducido como 8192 bytes. Si el datagrama es demasiado grande, esta función devolverá -1 y error() devolverá DatagramTooLargeError.
En general, no se recomienda enviar datagramas de más de 512 bytes, ya que, aunque se envíen correctamente, es probable que la capa IP los fragmente antes de que lleguen a su destino final.
Advertencia: Llamar a esta función en un socket UDP conectado puede provocar un error y que no se envíe ningún paquete. Si estás utilizando un socket conectado, utiliza write() para enviar datagramas.
Véanse también readDatagram() y write().
qint64 QUdpSocket::writeDatagram(const QNetworkDatagram &datagram)
Envía el datagrama datagram a la dirección de host y los números de puerto que figuran en datagram, utilizando la interfaz de red y los límites de número de saltos que también se establecen allí. Si no se han especificado la dirección de destino ni los números de puerto, esta función enviará el datagrama a la dirección que se haya pasado a connectToHost().
Si la dirección de destino es IPv6 con un scope id no vacío, pero difiere del índice de interfaz indicado en datagram, no está definido qué interfaz elegirá el sistema operativo para realizar el envío.
La función devuelve el número de bytes enviados si se ha realizado correctamente, o -1 si se ha producido un error.
Advertencia: Llamar a esta función en un socket UDP conectado puede provocar un error y que no se envíe ningún paquete. Si estás utilizando un socket conectado, utiliza write() para enviar datagramas.
Esta es una función sobrecargada.
Véase también QNetworkDatagram::setDestination(), QNetworkDatagram::setHopLimit() y QNetworkDatagram::setInterfaceIndex().
qint64 QUdpSocket::writeDatagram(const QByteArray &datagram, const QHostAddress &host, quint16 port)
Envía el datagrama datagram a la dirección de host host y al puerto port.
La función devuelve el número de bytes enviados si la operación se ha realizado correctamente, o -1 si se ha producido un error.
Se trata de una función sobrecargada.
© 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.