QLocalServer Class

Documentación de funciones miembro

[explicit] QLocalServer::QLocalServer(QObject *parent = nullptr)

Crea un nuevo servidor local de sockets con la dirección parent.

Véase también listen().

[virtual noexcept] QLocalServer::~QLocalServer()

Destruye el objeto QLocalServer. Si el servidor está escuchando conexiones, se cierra automáticamente.

Cualquier QLocalSockets cliente que aún esté conectado debe desconectarse o ser reparentado antes de que el servidor sea eliminado.

Ver también close().

[protected, since 6.8] void QLocalServer::addPendingConnection(QLocalSocket *socket)

Esta función es llamada por QLocalServer::incomingConnection() para añadir socket a la lista de conexiones entrantes pendientes.

Esta función se introdujo en Qt 6.8.

Véase también incomingConnection() y newConnection().

void QLocalServer::close()

Detiene la escucha de conexiones entrantes. Las conexiones existentes no se verán afectadas, pero las nuevas conexiones serán rechazadas.

Véase también isListening() y listen().

QString QLocalServer::errorString() const

Devuelve el mensaje legible por humanos apropiado para el error actual notificado por serverError(). Si no se dispone de una cadena adecuada, 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á escuchando.

Nota: Esto es específico 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)

Esta función virtual es llamada por QLocalServer cuando una nueva conexión está disponible. socketDescriptor es el descriptor de socket nativo para la conexión aceptada.

La implementación base crea un QLocalSocket, establece el descriptor de socket y luego almacena el QLocalSocket en una lista interna de conexiones pendientes. Finalmente se emite newConnection().

Reimplemente esta función para alterar el comportamiento del servidor cuando haya una conexión disponible.

Ver también newConnection(), nextPendingConnection(), y QLocalSocket::setSocketDescriptor().

bool QLocalServer::isListening() const

Devuelve true si el servidor está a la escucha de conexiones entrantes, false en caso contrario.

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á escuchando, listen() fallará. Devuelve true en caso de éxito, false en caso contrario.

name puede ser un único nombre y QLocalServer determinará la ruta correcta específica de la plataforma. serverName() devolverá el nombre que fue pasado a listen().

Normalmente se pasa un nombre como "foo", pero en Unix puede ser una ruta como "/tmp/foo" y en Windows puede ser una ruta como "\pipe\foo ".

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á escuchando actualmente. En caso de éxito, devuelve true; en caso contrario, devuelve false. El socket debe estar preparado para aceptar nuevas conexiones sin que se llamen funciones adicionales específicas de la plataforma. El socket se pone en modo no-bloqueo.

serverName(), fullServerName() pueden devolver una cadena con un nombre si esta opción está soportada por la plataforma; en caso contrario, devuelven un QString vacío. En particular, las direcciones de sockets en el espacio de nombres abstracto soportado por Linux no producirán nombres útiles si contienen caracteres no imprimibles.

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

[since 6.3] int QLocalServer::listenBacklogSize() const

Devuelve el tamaño de la cola de conexiones pendientes de aceptar.

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 hijo del servidor, lo que significa que se borra automáticamente cuando se destruye el objeto QLocalServer. Aún así, es una buena idea borrar el objeto explícitamente cuando haya terminado con él, para evitar desperdiciar 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 de servidor que pudiera hacer fallar una llamada a listen() y devuelve true si tiene éxito; en caso contrario devuelve false. Esta función está pensada para recuperarse de un fallo, cuando la instancia anterior del servidor no ha sido limpiada.

En Windows, esta función no hace nada; en Unix, elimina el fichero de socket dado por name.

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 el servidor está escuchando 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 de aceptar en size. El sistema operativo puede reducir o ignorar este valor. Por defecto, el tamaño de la cola es 50.

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 pendientes aceptadas 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 después de haber alcanzado su número máximo de conexiones pendientes, el sistema operativo puede seguir manteniéndolas en cola, lo que hará que los clientes indiquen que está conectado.

Véase también maxPendingConnections() y hasPendingConnections().

qintptr QLocalServer::socketDescriptor() const

Devuelve el descriptor de socket nativo que el servidor utiliza para escuchar las instrucciones entrantes, o -1 si el servidor no está escuchando.

El tipo de descriptor depende de la plataforma:

• En Windows, el valor devuelto es un Winsock 2 Socket Handle.
• En INTEGRITY, el valor devuelto es el descriptor de socket QTcpServer y el tipo está definido por socketDescriptor.
• En todos los demás sistemas operativos tipo UNIX, el tipo es un descriptor de fichero que representa un socket a la escucha.

Véase también listen().

QLocalServer::SocketOptions QLocalServer::socketOptions() const

Devuelve las opciones de socket establecidas en el socket.

Véase también setSocketOptions().

bool QLocalServer::waitForNewConnection(int msec = 0, bool *timedOut = nullptr)

Espera como máximo msec milisegundos o hasta que haya una conexión disponible. Devuelve true si hay una conexión disponible; en caso contrario, devuelve false. Si la operación ha expirado y timedOut no es nullptr, *timedOut se pondrá a true.

Se trata de una llamada a una función de bloqueo. Su uso es desaconsejable en una aplicación GUI monohilo, ya que toda la aplicación dejará de responder hasta que la función retorne. waitForNewConnection() es útil sobre todo cuando no hay un bucle de eventos disponible.

La alternativa no bloqueante es 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().