QDBusConnection Class

Documentación de las funciones miembro

[explicit] QDBusConnection::QDBusConnection(const QString &name)

Crea un objeto QDBusConnection adjunto a la conexión con nombre name.

Esto no abre la conexión. Tienes que llamar a connectToBus() para abrirla.

QDBusConnection::QDBusConnection(const QDBusConnection &other)

Crea una copia de la conexión other.

[noexcept] QDBusConnection::~QDBusConnection()

Elimina este objeto. Esto no cierra la conexión: tienes que llamar a disconnectFromBus() para hacerlo.

QDBusPendingCall QDBusConnection::asyncCall(const QDBusMessage &message, int timeout = -1) const

Envía la dirección message a través de esta conexión y la devuelve inmediatamente. Esta función sólo es adecuada para llamadas a métodos. Devuelve un objeto de tipo QDBusPendingCall que puede utilizarse para seguir el estado de la respuesta.

Si no se recibe respuesta en timeout milisegundos, se entregará un error automático indicando la expiración de la llamada. El valor por defecto de timeout es -1, que será sustituido por un valor definido por la implementación que sea adecuado para las comunicaciones entre procesos (generalmente, 25 segundos). Este tiempo de espera es también el límite superior de espera en QDBusPendingCall::waitForFinished().

Véase la función QDBusInterface::asyncCall() para una forma más amigable de realizar llamadas.

QString QDBusConnection::baseService() const

Devuelve el nombre de conexión único para esta conexión, si este objeto QDBusConnection está conectado, o un QString vacío en caso contrario.

Un Nombre Único de Conexión es una cadena en la forma ":x.xxx" (donde x son dígitos decimales) que es asignada por el demonio del servidor D-Bus al conectarse. Identifica de forma única a este cliente en el bus.

Esta función devuelve un QString vacío para conexiones peer-to-peer.

QDBusMessage QDBusConnection::call(const QDBusMessage &message, QDBus::CallMode mode = QDBus::Block, int timeout = -1) const

Envía el mensaje message a través de esta conexión y se bloquea, esperando una respuesta, durante un máximo de timeout milisegundos. Esta función sólo es adecuada para llamadas a métodos. Devuelve el mensaje de respuesta como valor de retorno, que será del tipo QDBusMessage::ReplyMessage o QDBusMessage::ErrorMessage.

Si no se recibe ninguna respuesta en timeout milisegundos, se emitirá un error automático indicando la expiración de la llamada. El valor por defecto de timeout es -1, que será sustituido por un valor definido por la implementación que sea adecuado para las comunicaciones entre procesos (generalmente, 25 segundos).

Véase la función QDBusInterface::call() para una forma más amigable de realizar llamadas.

bool QDBusConnection::callWithCallback(const QDBusMessage &message, QObject *receiver, const char *returnMethod, const char *errorMethod, int timeout = -1) const

Envía el message a través de esta conexión y retorna inmediatamente. Cuando se recibe la respuesta, se llama al método returnMethod en el objeto receiver. Si se produce un error, se llamará al método errorMethod en su lugar.

Si no se recibe respuesta en timeout milisegundos, se emitirá un error automático indicando la expiración de la llamada. El valor por defecto de timeout es -1, que será sustituido por un valor definido por la implementación que sea adecuado para las comunicaciones entre procesos (generalmente, 25 segundos).

Esta función sólo es adecuada para llamadas a métodos. Se garantiza que la ranura se llamará exactamente una vez con la respuesta, siempre que los tipos de parámetros coincidan y no se produzca ningún error.

Devuelve true si el mensaje fue enviado, o false si el mensaje no pudo ser enviado.

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, QObject *receiver, const char *slot)

Conecta la señal especificada por los parámetros service, path, interface y name a la ranura slot del objeto receiver. Los argumentos service y path pueden estar vacíos, denotando una conexión a cualquier señal del par (interface, name), desde cualquier aplicación remota.

Devuelve true si la conexión se ha realizado correctamente.

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject *receiver, const char *slot)

Conecta la señal a la ranura slot en el objeto receiver. A diferencia de la anterior sobrecarga connect(), esta función permite especificar la firma del parámetro a conectar utilizando la variable signature. La función verificará entonces que esta firma puede ser entregada a la ranura especificada por slot y devolverá false en caso contrario.

Devuelve true si la conexión se ha realizado correctamente.

bool QDBusConnection::connect(const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject *receiver, const char *slot)

Conecta la señal a la ranura slot en el objeto receiver. A diferencia de la anterior sobrecarga connect(), esta función permite especificar la firma del parámetro a conectar utilizando la variable signature. La función verificará entonces que esta firma puede ser entregada a la ranura especificada por slot y devolverá false en caso contrario.

El parámetro argumentMatch enumera los parámetros de cadena que deben coincidir, en orden secuencial. Tenga en cuenta que, para que coincida con una cadena vacía, debe pasar un QString que esté vacío pero no sea nulo (es decir, QString("")). Un QString nulo omite la coincidencia en esa posición.

Devuelve true si la conexión se ha realizado correctamente.

[static] QDBusConnection QDBusConnection::connectToBus(QDBusConnection::BusType type, const QString &name)

Abre una conexión de tipo type a uno de los buses conocidos y le asocia el nombre de conexión name. Devuelve un objeto QDBusConnection asociado a dicha conexión.

[static] QDBusConnection QDBusConnection::connectToBus(const QString &address, const QString &name)

Abre una conexión a un bus privado en la dirección address y le asocia el nombre de conexión name. Devuelve un objeto QDBusConnection asociado a dicha conexión.

[static] QDBusConnection QDBusConnection::connectToPeer(const QString &address, const QString &name)

Abre una conexión peer-to-peer en la dirección address y le asocia el nombre de conexión name. Devuelve un objeto QDBusConnection asociado a dicha conexión.

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities() const

Devuelve las capacidades de esta conexión tal y como se negociaron con el servidor de bus o par. Si este QDBusConnection no está conectado, esta función no devuelve ninguna capacidad.

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, QObject *receiver, const char *slot)

Desconecta la señal especificada por los parámetros service, path, interface y name de la ranura slot del objeto receiver. Los argumentos deben ser los mismos que los pasados a la función connect().

Devuelve true si la desconexión se ha realizado correctamente.

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject *receiver, const char *slot)

Desconecta la señal especificada por los parámetros service, path, interface, name, y signature de la ranura slot del objeto receiver. Los argumentos deben ser los mismos que los pasados a la función connect().

Devuelve true si la desconexión se ha realizado correctamente.

bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject *receiver, const char *slot)

Desconecta la señal especificada por los parámetros service, path, interface, name, argumentMatch, y signature de la ranura slot del objeto receiver. Los argumentos deben ser los mismos que los pasados a la función connect().

Devuelve true si la desconexión se ha realizado correctamente.

[static] void QDBusConnection::disconnectFromBus(const QString &name)

Cierra la conexión de bus de nombre name.

Tenga en cuenta que si todavía hay objetos QDBusConnection asociados con la misma conexión, la conexión no se cerrará hasta que se eliminen todas las referencias. Sin embargo, no se pueden crear más referencias utilizando el constructor QDBusConnection.

[static] void QDBusConnection::disconnectFromPeer(const QString &name)

Cierra la conexión de pares de nombre name.

Ten en cuenta que si todavía hay objetos QDBusConnection asociados a la misma conexión, la conexión no se cerrará hasta que se eliminen todas las referencias. Sin embargo, no se pueden crear más referencias utilizando el constructor QDBusConnection.

QDBusConnectionInterface *QDBusConnection::interface() const

Devuelve un objeto QDBusConnectionInterface que representa la interfaz del servidor D-Bus en esta conexión.

bool QDBusConnection::isConnected() const

Devuelve true si este objeto QDBusConnection está conectado.

QDBusError QDBusConnection::lastError() const

Devuelve el último error ocurrido en esta conexión.

Esta función se proporciona para código de bajo nivel. Si está utilizando QDBusInterface::call(), los códigos de error se informan mediante su valor de retorno.

Véase también QDBusInterface y QDBusMessage.

[static] QByteArray QDBusConnection::localMachineId()

Devuelve el ID de la máquina local conocido por el sistema D-Bus. Cada nodo o host que ejecuta D-Bus tiene un identificador único que puede ser usado para distinguirlo de otros hosts si están compartiendo recursos como el sistema de archivos.

Ten en cuenta que no está garantizado que el ID de la máquina local sea persistente a través de los arranques del sistema, por lo que este identificador no debe ser almacenado en un almacenamiento persistente (como el sistema de archivos). Se garantiza que permanecerá constante sólo durante el tiempo de vida de esta sesión de arranque.

QString QDBusConnection::name() const

Devuelve el nombre de conexión para esta conexión, tal y como se da como parámetro de nombre a connectToBus().

El nombre de la conexión se puede utilizar para identificar de forma única las conexiones subyacentes reales a los buses. Las copias realizadas a partir de una única conexión siempre compartirán implícitamente la conexión subyacente y, por lo tanto, tendrán el mismo nombre de conexión.

A la inversa, dos conexiones que tengan nombres de conexión diferentes siempre estarán conectadas a buses diferentes, o tendrán un nombre único diferente (devuelto por baseService()) en ese bus.

Véase también connectToBus() y disconnectFromBus().

QObject *QDBusConnection::objectRegisteredAt(const QString &path) const

Devuelve el objeto que se registró con registerObject() en la ruta del objeto dada por path.

bool QDBusConnection::registerObject(const QString &path, QObject *object, QDBusConnection::RegisterOptions options = ExportAdaptors)

Registra el objeto object en la ruta path y devuelve true si el registro se ha realizado correctamente. El parámetro options especifica qué parte del objeto object se expondrá a través de D-Bus.

Esta función no reemplaza objetos existentes: si ya hay un objeto registrado en la ruta path, esta función devolverá false. Utilice unregisterObject() para desregistrarlo primero.

La bandera ExportChildObjects exporta objetos hijos en D-Bus basándose en la ruta de los objetos registrados y en QObject::objectName del hijo. Por lo tanto, es importante que el objeto hijo tenga un nombre de objeto.

No se puede registrar un objeto como hijo de un objeto registrado con ExportChildObjects.

bool QDBusConnection::registerObject(const QString &path, const QString &interface, QObject *object, QDBusConnection::RegisterOptions options = ExportAdaptors)

Registra el objeto object en la ruta path con el nombre de interfaz interface y devuelve true si el registro se ha realizado correctamente. El parámetro options especifica qué parte del objeto object se expondrá a través de D-Bus.

Esta función no reemplaza objetos existentes: si ya hay un objeto registrado en la ruta path, esta función devolverá false. Utilice unregisterObject() para desregistrarlo primero.

La bandera ExportChildObjects exporta objetos hijos en D-Bus basándose en la ruta de los objetos registrados y en QObject::objectName del hijo. Por lo tanto, es importante que el objeto hijo tenga un nombre de objeto.

No se puede registrar un objeto como hijo de un objeto registrado con ExportChildObjects.

bool QDBusConnection::registerService(const QString &serviceName)

Intenta registrar serviceName en el servidor D-Bus y devuelve true si el registro se ha realizado correctamente. El registro fallará si el nombre ya está registrado por otra aplicación.

Véase también unregisterService() y QDBusConnectionInterface::registerService().

bool QDBusConnection::send(const QDBusMessage &message) const

Envía la dirección message a través de esta conexión, sin esperar respuesta. Esto es adecuado para errores, señales y valores de retorno, así como para llamadas cuyos valores de retorno no son necesarios.

Devuelve true si el mensaje se puso en cola con éxito, false en caso contrario.

[static] QDBusConnection QDBusConnection::sessionBus()

Devuelve un objeto QDBusConnection abierto con el bus de sesión. La referencia al objeto devuelta por esta función es válida hasta que la aplicación finalice, momento en el que se cerrará la conexión y se borrará el objeto.

[noexcept] void QDBusConnection::swap(QDBusConnection &other)

Intercambia esta conexión con other. Esta operación es muy rápida y nunca falla.

[static] QDBusConnection QDBusConnection::systemBus()

Devuelve un objeto QDBusConnection abierto con el bus del sistema. La referencia al objeto devuelta por esta función es válida hasta que se ejecute el destructor de QCoreApplication, momento en el que se cerrará la conexión y se borrará el objeto.

void QDBusConnection::unregisterObject(const QString &path, QDBusConnection::UnregisterMode mode = UnregisterNode)

Desregistra un objeto que se registró con registerObject() en la ruta de objeto dada por path y, si mode es QDBusConnection::UnregisterTree, también todos sus subobjetos.

Tenga en cuenta que no puede anular el registro de objetos que no se hayan registrado con registerObject().

bool QDBusConnection::unregisterService(const QString &serviceName)

Desregistra el servicio serviceName que fue previamente registrado con registerService() y devuelve true si tuvo éxito.

Véase también registerService() y QDBusConnectionInterface::unregisterService().

QDBusConnection &QDBusConnection::operator=(const QDBusConnection &other)

Crea una copia de la conexión other en este objeto. Tenga en cuenta que la conexión a la que este objeto hacía referencia antes de la copia, no se desconecta espontáneamente.

Véase también disconnectFromBus().