QLocalServer Class
La clase QLocalServer proporciona un servidor local basado en sockets. Más información...
| Encabezado: | #include <QLocalServer> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Network) target_link_libraries(mytarget PRIVATE Qt6::Network) |
| qmake: | QT += network |
| Heredado de: | QObject |
Tipos públicos
| enum | SocketOption { NoOptions, UserAccessOption, GroupAccessOption, OtherAccessOption, WorldAccessOption, AbstractNamespaceOption } |
| flags | SocketOptions |
Propiedades
- socketOptions : SocketOptions
Funciones públicas
| QLocalServer(QObject *parent = nullptr) | |
| virtual | ~QLocalServer() |
| QBindable<QLocalServer::SocketOptions> | bindableSocketOptions() |
| void | close() |
| QString | errorString() const |
| QString | fullServerName() const |
| virtual bool | hasPendingConnections() const |
| bool | isListening() const |
| bool | listen(const QString &name) |
| bool | listen(qintptr socketDescriptor) |
(since 6.3) int | listenBacklogSize() const |
| int | maxPendingConnections() const |
| virtual QLocalSocket * | nextPendingConnection() |
| QAbstractSocket::SocketError | serverError() const |
| QString | serverName() const |
(since 6.3) void | setListenBacklogSize(int size) |
| void | setMaxPendingConnections(int numConnections) |
| void | setSocketOptions(QLocalServer::SocketOptions options) |
| qintptr | socketDescriptor() const |
| QLocalServer::SocketOptions | socketOptions() const |
| bool | waitForNewConnection(int msec = 0, bool *timedOut = nullptr) |
Señales
| void | newConnection() |
Miembros públicos estáticos
| bool | removeServer(const QString &name) |
Funciones protegidas
(since 6.8) void | addPendingConnection(QLocalSocket *socket) |
| virtual void | incomingConnection(quintptr socketDescriptor) |
Descripción detallada
Esta clase permite aceptar conexiones de socket locales entrantes.
Llama a ` listen()` para que el servidor comience a escuchar conexiones entrantes en una clave especificada. A continuación, se emite la señal ` newConnection()` cada vez que un cliente se conecta al servidor.
Llama a ` nextPendingConnection()` para aceptar la conexión pendiente como un ` QLocalSocket` conectado. La función devuelve un puntero a un ` QLocalSocket ` que puede utilizarse para comunicarse con el cliente.
Si se produce un error, serverError() devuelve el tipo de error, y se puede llamar a errorString() para obtener una descripción legible por el usuario de lo que ha ocurrido.
Al estar a la espera de conexiones, el nombre en el que el servidor está a la escucha está disponible a través de ` serverName()` ().
Al llamar a ` close()` se hace que QLocalServer deje de escuchar conexiones entrantes.
Aunque QLocalServer está diseñado para utilizarse con un bucle de eventos, es posible utilizarlo sin él. En ese caso, debes utilizar ` waitForNewConnection()`, que se bloquea hasta que haya una conexión disponible o se agote el tiempo de espera.
Véase también QLocalSocket y QTcpServer.
Documentación sobre los tipos de miembros
enum QLocalServer::SocketOption
flags QLocalServer::SocketOptions
Esta enumeración describe las posibles opciones que se pueden utilizar para crear el socket. Esto modifica los permisos de acceso en aquellas plataformas (Linux, Windows) que admiten permisos de acceso en el socket. Tanto «GroupAccess» como «OtherAccess» pueden presentar ligeras variaciones en su significado dependiendo de la plataforma. En Linux y Android es posible utilizar sockets con direcciones abstractas; los permisos de los sockets no tienen relevancia para este tipo de sockets.
| Constante | Valor | Descripción |
|---|---|---|
QLocalServer::NoOptions | 0x0 | No se han establecido restricciones de acceso. |
QLocalServer::UserAccessOption | 0x01 | El acceso está restringido al mismo usuario que el proceso que creó el socket. |
QLocalServer::GroupAccessOption | 0x2 | En Linux, el acceso está restringido al mismo grupo, pero no al usuario que creó el socket. En Windows, el acceso está restringido al grupo principal del proceso |
QLocalServer::OtherAccessOption | 0x4 | El acceso está disponible para todos, excepto para el usuario y el grupo que crearon el socket en Linux. El acceso está disponible para todos en Windows. |
QLocalServer::WorldAccessOption | 0x7 | Sin restricciones de acceso. |
QLocalServer::AbstractNamespaceOption | 0x8 | El socket de escucha se creará en el espacio de nombres abstracto. Este indicador es específico de Linux. En el caso de otras plataformas, en aras de la portabilidad del código, este indicador es equivalente a WorldAccessOption. |
El tipo `SocketOptions` es un `typedef` para ` QFlags<SocketOption>`. Almacena una combinación OR de valores de `SocketOption`.
Véase también socketOptions.
Documentación de propiedades
[bindable] socketOptions : SocketOptions
Nota: Esta propiedad admite enlaces de tipo « QProperty ».
Esta propiedad contiene las opciones del socket que controlan su funcionamiento.
Por ejemplo, el socket puede restringir el acceso a determinados ID de usuario que pueden conectarse al mismo.
Estas opciones deben configurarse antes de llamar a ` listen()`.
En algunos casos, como con los sockets de dominio Unix en Linux, el acceso al socket vendrá determinado por los permisos del sistema de archivos y se creará en función de la umask. Al establecer los indicadores de acceso se anulará esto y se restringirá o permitirá el acceso según se especifique.
Otros sistemas operativos basados en Unix, como macOS, no respetan los permisos de archivo para los sockets de dominio Unix y, por defecto, tienen acceso global (WorldAccess), por lo que estas opciones de permisos no tendrán ningún efecto.
En Windows, « UserAccessOption » es suficiente para permitir que un proceso sin privilegios elevados se conecte a un servidor local creado por un proceso con privilegios elevados ejecutado por el mismo usuario. « GroupAccessOption » hace referencia al grupo primario del proceso (véase «TokenPrimaryGroup» en la documentación de Windows). « OtherAccessOption » hace referencia al conocido grupo «Everyone».
En plataformas Linux es posible crear un socket en el espacio de nombres abstracto, que es independiente del sistema de archivos. El uso de este tipo de socket implica ignorar las opciones de permisos. En otras plataformas, AbstractNamespaceOption es equivalente a WorldAccessOption.
Por defecto, no se establece ninguna de las opciones; los permisos de acceso son los predeterminados de la plataforma.
Funciones de acceso:
| QLocalServer::SocketOptions | socketOptions() const |
| void | setSocketOptions(QLocalServer::SocketOptions options) |
Véase también listen().
Documentación de las funciones miembro
[explicit] QLocalServer::QLocalServer(QObject *parent = nullptr)
Crea un nuevo servidor de socket local con el parent indicado.
Véase también listen().
[virtual noexcept] QLocalServer::~QLocalServer()
Destruye el objeto ` QLocalServer `. Si el servidor está a la espera de conexiones, se cierra automáticamente.
Cualquier QLocalSocket de cliente que siga conectado deberá desconectarse o cambiarse de padre antes de que se elimine el servidor.
Véase también close().
[protected, since 6.8] void QLocalServer::addPendingConnection(QLocalSocket *socket)
Esta función es llamada por ` QLocalServer::incomingConnection()` para añadir el ` socket ` a la lista de conexiones entrantes pendientes.
Nota: No olvides llamar a este miembro desde la función ` incomingConnection()` reimplementada si no quieres alterar el mecanismo de conexiones pendientes. Esta función emite la señal ` newConnection()` una vez que se ha añadido el socket.
Esta función se introdujo en Qt 6.8.
Véase también ` incomingConnection()` y ` newConnection()`.
void QLocalServer::close()
Deja de escuchar conexiones entrantes. Las conexiones existentes no se verán afectadas, pero se rechazarán las nuevas conexiones.
Véase también isListening() y listen().
QString QLocalServer::errorString() const
Devuelve el mensaje legible para el usuario correspondiente al error actual notificado por serverError(). Si no hay ninguna cadena adecuada disponible, se devuelve una cadena vacía.
Véase también serverError().
QString QLocalServer::fullServerName() const
Devuelve la ruta completa en la que el servidor está a la escucha.
Nota: Esto depende de la plataforma
Véase también listen() y serverName().
[virtual] bool QLocalServer::hasPendingConnections() const
Devuelve « true » si el servidor tiene una conexión pendiente; en caso contrario, devuelve « false ».
Véase también nextPendingConnection() y setMaxPendingConnections().
[virtual protected] void QLocalServer::incomingConnection(quintptr socketDescriptor)
QLocalServer llama a esta función virtual cuando hay una nueva conexión disponible. socketDescriptor es el descriptor de socket nativo de la conexión aceptada.
La implementación básica crea un ` QLocalSocket`, establece el descriptor de socket y, a continuación, almacena el ` QLocalSocket ` en una lista interna de conexiones pendientes. Por último, se emite ` newConnection()`.
Reimplementa esta función para modificar el comportamiento del servidor cuando haya una conexión disponible.
Véase también newConnection(), nextPendingConnection() y QLocalSocket::setSocketDescriptor().
bool QLocalServer::isListening() const
Devuelve « true » si el servidor está a la escucha de conexiones entrantes; en caso contrario, devuelve « false ».
Véase también listen() y close().
bool QLocalServer::listen(const QString &name)
Indica al servidor que escuche las conexiones entrantes en name. Si el servidor ya está a la escucha, la función listen() dará error. Devuelve true en caso de éxito, y false en caso contrario.
name Puede ser un único nombre y QLocalServer determinará la ruta específica correcta para cada plataforma. serverName() devolverá el nombre que se pasó a listen().
Normalmente, basta con pasar un nombre como «foo», pero en Unix también podría ser una ruta como «/tmp/foo» y en Windows podría ser una ruta de tubería como «\\.\pipe\foo ».
Nota: En Unix, si el servidor se ha bloqueado previamente sin cerrarse, la función listen() fallará con el error AddressInUseError. Para crear un nuevo servidor, primero hay que eliminar el archivo. En Windows, dos servidores locales pueden escuchar la misma tubería al mismo tiempo, pero cada conexión entrante se dirigirá a cualquiera de ellos.
Véase también serverName(), isListening() y close().
bool QLocalServer::listen(qintptr socketDescriptor)
Indica al servidor que escuche las conexiones entrantes en socketDescriptor. La propiedad devuelve false si el servidor está actualmente a la escucha. Devuelve true si la operación se realiza con éxito; en caso contrario, devuelve false. El socket debe estar listo para aceptar nuevas conexiones sin que se hayan llamado funciones adicionales específicas de la plataforma. El socket se configura en modo no bloqueante.
serverName(), fullServerName() pueden devolver una cadena con un nombre si la plataforma admite esta opción; de lo contrario, devuelven un QString vacío. En concreto, las direcciones de los sockets en el espacio de nombres abstracto admitido por Linux no proporcionarán nombres útiles si contienen caracteres no imprimibles.
Véanse también isListening() y close().
[since 6.3] int QLocalServer::listenBacklogSize() const
Devuelve el tamaño de la cola de conexiones pendientes de aceptación.
Esta función se introdujo en Qt 6.3.
Véase también ` setListenBacklogSize()`.
int QLocalServer::maxPendingConnections() const
Devuelve el número máximo de conexiones aceptadas pendientes. El valor por defecto es 30.
Véase también setMaxPendingConnections() y hasPendingConnections().
[signal] void QLocalServer::newConnection()
Esta señal se emite cada vez que hay una nueva conexión disponible.
Véase también hasPendingConnections() y nextPendingConnection().
[virtual] QLocalSocket *QLocalServer::nextPendingConnection()
Devuelve la siguiente conexión pendiente como un objeto ` QLocalSocket ` conectado.
El socket se crea como un hijo del servidor, lo que significa que se elimina automáticamente cuando se destruye el objeto ` QLocalServer `. No obstante, es recomendable eliminar el objeto de forma explícita cuando ya no se necesite, para evitar el desperdicio de memoria.
nullptr Se devuelve si se llama a esta función cuando no hay conexiones pendientes.
Véase también ` hasPendingConnections()`, ` newConnection()` y ` incomingConnection()`.
[static] bool QLocalServer::removeServer(const QString &name)
Elimina cualquier instancia del servidor que pueda provocar que falle una llamada a ` listen()` y devuelve ` true ` si se realiza correctamente; en caso contrario, devuelve ` false`. Esta función está pensada para recuperarse de un fallo del sistema, cuando la instancia anterior del servidor no se ha limpiado.
En Windows, esta función no hace nada; en Unix, elimina el archivo de socket indicado por name.
Advertencia: Hay que tener cuidado de no eliminar sockets de instancias en ejecución.
QAbstractSocket::SocketError QLocalServer::serverError() const
Devuelve el tipo de error que se produjo en último lugar o NoError.
Véase también errorString().
QString QLocalServer::serverName() const
Devuelve el nombre del servidor si este está a la espera de conexiones; en caso contrario, devuelve QString().
Véase también listen() y fullServerName().
[since 6.3] void QLocalServer::setListenBacklogSize(int size)
Establece el tamaño de la cola de conexiones pendientes que se van a aceptar en size. Es posible que el sistema operativo reduzca o ignore este valor. Por defecto, el tamaño de la cola es 50.
Nota: Esta propiedad debe configurarse antes de llamar a listen().
Esta función se introdujo en Qt 6.3.
Véase también ` listenBacklogSize()`.
void QLocalServer::setMaxPendingConnections(int numConnections)
Establece el número máximo de conexiones aceptadas pendientes en numConnections. QLocalServer no aceptará más de numConnections conexiones entrantes antes de que se llame a nextPendingConnection().
Nota: Aunque QLocalServer dejará de aceptar nuevas conexiones una vez alcanzado el número máximo de conexiones pendientes, es posible que el sistema operativo las mantenga en cola, lo que provocará que los clientes indiquen que están conectados.
Véase también maxPendingConnections() y hasPendingConnections().
qintptr QLocalServer::socketDescriptor() const
Devuelve el descriptor de socket nativo que utiliza el servidor para escuchar las instrucciones entrantes, o -1 si el servidor no está a la escucha.
El tipo del descriptor depende de la plataforma:
- En Windows, el valor devuelto es un identificador de socket de Winsock 2.
- En INTEGRITY, el valor devuelto es el descriptor de socket « QTcpServer » y el tipo viene definido por socketDescriptor.
- En el resto de sistemas operativos de tipo UNIX, el tipo es un descriptor de archivo que representa un socket en escucha.
Véase también listen().
QLocalServer::SocketOptions QLocalServer::socketOptions() const
Devuelve las opciones de socket configuradas en el socket.
Nota: Funcióngetter para la propiedad socketOptions.
Véase también ` setSocketOptions()`.
bool QLocalServer::waitForNewConnection(int msec = 0, bool *timedOut = nullptr)
Espera un máximo de msec milisegundos o hasta que haya una conexión entrante disponible. Devuelve true si hay una conexión disponible; en caso contrario, devuelve false. Si la operación ha agotado el tiempo de espera y timedOut no es nullptr, *timedOut se establecerá en true.
Se trata de una llamada a función bloqueante. No se recomienda su uso en una aplicación GUI de un solo hilo, ya que toda la aplicación dejará de responder hasta que la función devuelva un resultado. waitForNewConnection() resulta especialmente útil cuando no hay ningún bucle de eventos disponible.
La alternativa no bloqueante consiste en conectarse a la señal « newConnection()».
Si msec es -1, esta función no agotará el tiempo de espera.
Véase también ` hasPendingConnections()` y ` nextPendingConnection()`.
© 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.