A D-Bus Connection. More...
#include <giomm/dbusconnection.h>
Public Types | |
| using | SlotSignal = sigc::slot< void(const Glib::RefPtr< Connection > &, const Glib::ustring &, const Glib::ustring &, const Glib::ustring &, const Glib::ustring &, const Glib::VariantContainerBase &)> |
| Signature for slot used in signal_subscribe(). | |
| using | SlotMessageFilter = sigc::slot< Glib::RefPtr< Message >(const Glib::RefPtr< Connection > &, const Glib::RefPtr< Message > &, bool)> |
| Signature for slot used in add_filter(). | |
 Public Types inherited from Glib::Object | |
| using | DestroyNotify = void(*)(gpointer data) |
Related Symbols | |
(Note that these are not member symbols.) | |
| Glib::RefPtr< Gio::DBus::Connection > | wrap (GDBusConnection *object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
| Related Symbols inherited from Glib::Object | |
| Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
| Related Symbols inherited from Gio::Initable | |
| Glib::RefPtr< Gio::Initable > | wrap (GInitable *object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
| Related Symbols inherited from Gio::AsyncInitable | |
| Glib::RefPtr< Gio::AsyncInitable > | wrap (GAsyncInitable *object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
Detailed Description
A D-Bus Connection.
The Connection type is used for D-Bus connections to remote peers such as message buses. It is a low-level API that offers a lot of flexibility. For instance, it lets you establish a connection over any transport that can by represented as an IOStream.
This class is rarely used directly in D-Bus clients. If you are writing a D-Bus client, it is often easier to use the Gio::DBus::own_name(), Gio::DBus::watch_name() or Gio::DBus::Proxy::create_for_bus() APIs.
Member Typedef Documentation
◆ SlotMessageFilter
| using Gio::DBus::Connection::SlotMessageFilter = sigc::slot<Glib::RefPtr<Message>( const Glib::RefPtr<Connection>&, const Glib::RefPtr<Message>&, bool)> |
Signature for slot used in add_filter().
For example,
A filter function is passed a Message and expected to return a Message too. Passive filter functions that don't modify the message can simply return the message object. Filter functions that wants to drop a message can simply return an empty RefPtr. And filter function may modify a message by copying it and return the copy.
◆ SlotSignal
Signature for slot used in signal_subscribe().
For example,
Constructor & Destructor Documentation
◆ Connection() [1/17]
|
noexcept |
◆ ~Connection()
|
overridenoexcept |
◆ Connection() [2/17]
|
protected |
◆ Connection() [3/17]
|
protected |
◆ Connection() [4/17]
|
protected |
◆ Connection() [5/17]
|
protected |
◆ Connection() [6/17]
|
protected |
◆ Connection() [7/17]
|
protected |
◆ Connection() [8/17]
|
protected |
◆ Connection() [9/17]
|
protected |
◆ Connection() [10/17]
|
protected |
◆ Connection() [11/17]
|
protected |
◆ Connection() [12/17]
|
protected |
◆ Connection() [13/17]
|
protected |
◆ Connection() [14/17]
|
protected |
◆ Connection() [15/17]
|
protected |
◆ Connection() [16/17]
|
protected |
◆ Connection() [17/17]
|
protected |
Member Function Documentation
◆ add_filter()
| guint Gio::DBus::Connection::add_filter | ( | const SlotMessageFilter & | slot | ) |
Adds a message filter.
Filters are handlers that are run on all incoming and outgoing messages, prior to standard dispatch. Filters are run in the order that they were added. The same handler can be added as a filter more than once, in which case it will be run more than once. Filters added during a filter slot won't be run on the message being processed. Filter slots are allowed to modify and even drop messages.
Note that filters are run in a dedicated message handling thread so they can't block and, generally, can't do anything but signal a worker thread. Also note that filters are rarely needed - use API such as send_message_with_reply(), signal_subscribe() or call() instead.
If a filter consumes an incoming message the message is not dispatched anywhere else - not even the standard dispatch machinery (that API such as signal_subscribe() and send_message_with_reply() relies on) will see the message. Similary, if a filter consumes an outgoing message, the message will not be sent to the other peer.
- Parameters
-
slot A filter slot.
- Returns
- A filter identifier that can be used with remove_filter().
◆ call() [1/4]
| void Gio::DBus::Connection::call | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| const Glib::RefPtr< UnixFDList > & | fd_list, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
Like call() but also takes a GUnixFDList object.
This method is only available on UNIX.
This is an asynchronous method. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call call_with_unix_fd_finish() to get the result of the operation. See call_sync() for the synchronous version of this function.
- Parameters
-
object_path Path of remote object. interface_name D-Bus interface to invoke method on. method_name The name of the method to invoke. parameters A Glib::VariantContainerBase tuple with parameters for the method or 0if not passing parameters.slot A SlotAsyncReady to call when the request is satisfied. cancellable A Cancellable. fd_list A UnixFDList. bus_name A unique or well-known bus name or an empty string if the connection is not a message bus connection. timeout_msec The timeout in milliseconds, -1 to use the default timeout or G_MAXINT for no timeout. flags Flags from the Gio::DBus::CallFlags enumeration. reply_type The expected type of the reply, or 0.
◆ call() [2/4]
| void Gio::DBus::Connection::call | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
Asynchronously invokes the method_name method on the interface_name D-Bus interface on the remote object at object_path owned by bus_name.
If the connection is closed then the operation will fail with Gio::Error::CLOSED. If cancellable is cancelled, the operation will fail with Gio::Error::CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with Gio::Error::INVALID_ARGUMENT.
If reply_type is non-0 then the reply will be checked for having this type and an error will be raised if it does not match. Said another way, if you give a reply_type then any non-0 return value will be of this type.
This is an asynchronous method. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call call_finish() to get the result of the operation. See call_sync() for the synchronous version of this function.
- Parameters
-
object_path Path of remote object. interface_name D-Bus interface to invoke method on. method_name The name of the method to invoke. parameters A Glib::VariantContainerBase tuple with parameters for the method or 0if not passing parameters.slot A SlotAsyncReady to call when the request is satisfied. cancellable A Cancellable. bus_name A unique or well-known bus name or an empty string if the connection is not a message bus connection. timeout_msec The timeout in milliseconds, -1 to use the default timeout or G_MAXINT for no timeout. flags Flags from the Gio::DBus::CallFlags enumeration. reply_type The expected type of the reply, or 0.
◆ call() [3/4]
| void Gio::DBus::Connection::call | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< UnixFDList > & | fd_list, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
A non-cancellable version of call() (with a UnixFDList).
◆ call() [4/4]
| void Gio::DBus::Connection::call | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
A non-cancellable version of call().
◆ call_finish() [1/2]
| Glib::VariantContainerBase Gio::DBus::Connection::call_finish | ( | const Glib::RefPtr< AsyncResult > & | res | ) |
Finishes an operation started with call().
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to call().
- Returns
- A Variant tuple with return values.
- Exceptions
-
Glib::Error.
◆ call_finish() [2/2]
| Glib::VariantContainerBase Gio::DBus::Connection::call_finish | ( | const Glib::RefPtr< AsyncResult > & | res, |
| Glib::RefPtr< UnixFDList > & | out_fd_list | ||
| ) |
Finishes an operation started with call() (with a UnixFDList).
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to call(). out_fd_list Return location for a UnixFDList.
- Returns
- A Variant tuple with return values.
- Exceptions
-
Glib::Error.
◆ call_sync() [1/4]
| Glib::VariantContainerBase Gio::DBus::Connection::call_sync | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| const Glib::RefPtr< UnixFDList > & | fd_list, | ||
| Glib::RefPtr< UnixFDList > & | out_fd_list, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
Like g_dbus_connection_call_sync() but also takes and returns UnixFDList objects.
See g_dbus_connection_call_with_unix_fd_list() and g_dbus_connection_call_with_unix_fd_list_finish() for more details.
This method is only available on UNIX.
- Parameters
-
bus_name A unique or well-known bus name or nullptrif connection is not a message bus connection.object_path Path of remote object. interface_name D-Bus interface to invoke method on. method_name The name of the method to invoke. parameters A Variant tuple with parameters for the method or nullptrif not passing parameters.reply_type The expected type of the reply, or nullptr.flags Flags from the Gio::DBus::CallFlags enumeration. timeout_msec The timeout in milliseconds, -1 to use the default timeout or G_MAXINT for no timeout. fd_list A UnixFDList or nullptr.out_fd_list Return location for a UnixFDList or nullptr.cancellable A Cancellable or nullptr.
- Returns
nullptrif error is set. Otherwise a non-floating Variant tuple with return values. Free with Glib::variant_unref().
- Exceptions
-
Glib::Error
◆ call_sync() [2/4]
| Glib::VariantContainerBase Gio::DBus::Connection::call_sync | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
Synchronously invokes the method_name method on the interface_name D-Bus interface on the remote object at object_path owned by bus_name.
If the connection is closed then the operation will fail with Gio::Error::CLOSED. If cancellable is cancelled, the operation will fail with Gio::Error::CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with Gio::Error::INVALID_ARGUMENT.
If reply_type is non-0 then the reply will be checked for having this type and an error will be raised if it does not match. Said another way, if you give a reply_type then any non-0 return value will be of this type.
The calling thread is blocked until a reply is received. See call() for the asynchronous version of this method.
- Parameters
-
object_path Path of remote object. interface_name D-Bus interface to invoke method on. method_name The name of the method to invoke. parameters A Glib::VariantContainerBase tuple with parameters for the method or 0if not passing parameters.cancellable A Cancellable. bus_name A unique or well-known bus name or an empty string if the connection is not a message bus connection. timeout_msec The timeout in milliseconds, -1 to use the default timeout or G_MAXINT for no timeout. flags Flags from the Gio::DBus::CallFlags enumeration. reply_type The expected type of the reply, or 0.
- Returns
- A Variant tuple with return values.
- Exceptions
-
Glib::Error.
◆ call_sync() [3/4]
| Glib::VariantContainerBase Gio::DBus::Connection::call_sync | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const Glib::RefPtr< UnixFDList > & | fd_list, | ||
| Glib::RefPtr< UnixFDList > & | out_fd_list, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
A call_sync() convenience overload.
◆ call_sync() [4/4]
| Glib::VariantContainerBase Gio::DBus::Connection::call_sync | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | method_name, | ||
| const Glib::VariantContainerBase & | parameters, | ||
| const Glib::ustring & | bus_name = {}, |
||
| int | timeout_msec = -1, |
||
| CallFlags | flags = Gio::DBus::CallFlags::NONE, |
||
| const Glib::VariantType & | reply_type = {} |
||
| ) |
A non-cancellable version of call_sync().
◆ close() [1/3]
| void Gio::DBus::Connection::close | ( | ) |
Closes the connection.
Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see property_exit_on_close()).
Once the connection is closed, operations such as sending a message will return with the error Gio::Error::CLOSED. Closing a connection will not automatically flush the connection so queued messages may be lost. Use flush() if you need such guarantees.
If the connection is already closed, this method fails with Gio::Error::CLOSED.
When the connection has been closed, the "closed" signal is emitted in the thread-default main loop of the thread that connection was constructed in.
This is an asynchronous method. See close_sync() for the synchronous version.
◆ close() [2/3]
Closes the connection.
Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see property_exit_on_close()).
Once the connection is closed, operations such as sending a message will return with the error Gio::Error::CLOSED. Closing a connection will not automatically flush the connection so queued messages may be lost. Use flush() if you need such guarantees.
If the connection is already closed, this method fails with Gio::Error::CLOSED.
When the connection has been closed, the "closed" signal is emitted in the thread-default main loop of the thread that connection was constructed in.
This is an asynchronous method. When the operation is finished, slot will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call close_finish() to get the result of the operation. See close_sync() for the synchronous version.
- Parameters
-
slot A SlotAsyncReady to call when the request is satisfied.
◆ close() [3/3]
| void Gio::DBus::Connection::close | ( | const SlotAsyncReady & | slot, |
| const Glib::RefPtr< Cancellable > & | cancellable | ||
| ) |
Closes the connection.
Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see property_exit_on_close()).
Once the connection is closed, operations such as sending a message will return with the error Gio::Error::CLOSED. Closing a connection will not automatically flush the connection so queued messages may be lost. Use flush() if you need such guarantees.
If the connection is already closed, this method fails with Gio::Error::CLOSED.
When the connection has been closed, the "closed" signal is emitted in the thread-default main loop of the thread that connection was constructed in.
This is an asynchronous method. When the operation is finished, slot will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call close_finish() to get the result of the operation. See close_sync() for the synchronous version.
- Parameters
-
slot A SlotAsyncReady to call when the request is satisfied. cancellable A Cancellable.
◆ close_finish()
| bool Gio::DBus::Connection::close_finish | ( | const Glib::RefPtr< AsyncResult > & | res | ) |
Finishes an operation started with g_dbus_connection_close().
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to g_dbus_connection_close().
- Returns
trueif the operation succeeded,falseif error is set.
- Exceptions
-
Glib::Error
◆ close_sync() [1/2]
| void Gio::DBus::Connection::close_sync | ( | ) |
A close_sync() convenience overload.
◆ close_sync() [2/2]
| void Gio::DBus::Connection::close_sync | ( | const Glib::RefPtr< Cancellable > & | cancellable | ) |
Synchronously closes connection.
The calling thread is blocked until this is done. See g_dbus_connection_close() for the asynchronous version of this method and more details about what it does.
- Parameters
-
cancellable A Cancellable or nullptr.
- Exceptions
-
Glib::Error
◆ create() [1/4]
|
static |
Non-cancellable version of create().
◆ create() [2/4]
|
static |
Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream.
If stream is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.
The D-Bus connection will interact with stream from a worker thread. As a result, the caller should not interact with stream after this method has been called, except by calling Glib::object_unref() on it.
If observer is not nullptr it may be used to control the authentication process.
When the operation is finished, slot will be invoked. You can then call g_dbus_connection_new_finish() to get the result of the operation.
This is an asynchronous failable constructor. See g_dbus_connection_new_sync() for the synchronous version.
- Parameters
-
stream A IOStream. guid The GUID to use if authenticating as a server or nullptr.flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.slot A SlotAsyncReady to call when the request is satisfied. user_data The data to pass to slot.
◆ create() [3/4]
|
static |
Non-cancellable version of create().
◆ create() [4/4]
|
static |
Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream.
If stream is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.
The D-Bus connection will interact with stream from a worker thread. As a result, the caller should not interact with stream after this method has been called, except by calling Glib::object_unref() on it.
If observer is not nullptr it may be used to control the authentication process.
When the operation is finished, slot will be invoked. You can then call g_dbus_connection_new_finish() to get the result of the operation.
This is an asynchronous failable constructor. See g_dbus_connection_new_sync() for the synchronous version.
- Parameters
-
stream A IOStream. guid The GUID to use if authenticating as a server or nullptr.flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.slot A SlotAsyncReady to call when the request is satisfied. user_data The data to pass to slot.
◆ create_finish()
|
static |
Finishes an operation started with g_dbus_connection_new().
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to g_dbus_connection_new().
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ create_for_address() [1/4]
|
static |
Non-cancellable version of create_for_address().
◆ create_for_address() [2/4]
|
static |
Asynchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by address which must be in the D-Bus address format.
This constructor can only be used to initiate client-side connections - use g_dbus_connection_new() if you need to act as the server. In particular, flags cannot contain the Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER, Gio::DBus::ConnectionFlags::AUTHENTICATION_ALLOW_ANONYMOUS or Gio::DBus::ConnectionFlags::AUTHENTICATION_REQUIRE_SAME_USER flags.
When the operation is finished, slot will be invoked. You can then call g_dbus_connection_new_for_address_finish() to get the result of the operation.
If observer is not nullptr it may be used to control the authentication process.
This is an asynchronous failable constructor. See g_dbus_connection_new_for_address_sync() for the synchronous version.
- Parameters
-
address A D-Bus address. flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.slot A SlotAsyncReady to call when the request is satisfied. user_data The data to pass to slot.
◆ create_for_address() [3/4]
|
static |
Non-cancellable version of create_for_address().
◆ create_for_address() [4/4]
|
static |
Asynchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by address which must be in the D-Bus address format.
This constructor can only be used to initiate client-side connections - use g_dbus_connection_new() if you need to act as the server. In particular, flags cannot contain the Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER, Gio::DBus::ConnectionFlags::AUTHENTICATION_ALLOW_ANONYMOUS or Gio::DBus::ConnectionFlags::AUTHENTICATION_REQUIRE_SAME_USER flags.
When the operation is finished, slot will be invoked. You can then call g_dbus_connection_new_for_address_finish() to get the result of the operation.
If observer is not nullptr it may be used to control the authentication process.
This is an asynchronous failable constructor. See g_dbus_connection_new_for_address_sync() for the synchronous version.
- Parameters
-
address A D-Bus address. flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.slot A SlotAsyncReady to call when the request is satisfied. user_data The data to pass to slot.
◆ create_for_address_finish()
|
static |
Finishes an operation started with g_dbus_connection_new_for_address().
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to g_dbus_connection_new().
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ create_for_address_sync() [1/4]
|
static |
Non-cancellable version of create_for_address_sync().
◆ create_for_address_sync() [2/4]
|
static |
Non-cancellable version of create_for_address_sync().
◆ create_for_address_sync() [3/4]
|
static |
Synchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by address which must be in the D-Bus address format.
This constructor can only be used to initiate client-side connections - use g_dbus_connection_new_sync() if you need to act as the server. In particular, flags cannot contain the Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER, Gio::DBus::ConnectionFlags::AUTHENTICATION_ALLOW_ANONYMOUS or Gio::DBus::ConnectionFlags::AUTHENTICATION_REQUIRE_SAME_USER flags.
This is a synchronous failable constructor. See g_dbus_connection_new_for_address() for the asynchronous version.
If observer is not nullptr it may be used to control the authentication process.
- Parameters
-
address A D-Bus address. flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ create_for_address_sync() [4/4]
|
static |
Synchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by address which must be in the D-Bus address format.
This constructor can only be used to initiate client-side connections - use g_dbus_connection_new_sync() if you need to act as the server. In particular, flags cannot contain the Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER, Gio::DBus::ConnectionFlags::AUTHENTICATION_ALLOW_ANONYMOUS or Gio::DBus::ConnectionFlags::AUTHENTICATION_REQUIRE_SAME_USER flags.
This is a synchronous failable constructor. See g_dbus_connection_new_for_address() for the asynchronous version.
If observer is not nullptr it may be used to control the authentication process.
- Parameters
-
address A D-Bus address. flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ create_sync() [1/4]
|
static |
Non-cancellable version of create_sync().
◆ create_sync() [2/4]
|
static |
Non-cancellable version of create_sync().
◆ create_sync() [3/4]
|
static |
Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream.
If stream is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.
The D-Bus connection will interact with stream from a worker thread. As a result, the caller should not interact with stream after this method has been called, except by calling Glib::object_unref() on it.
If observer is not nullptr it may be used to control the authentication process.
This is a synchronous failable constructor. See g_dbus_connection_new() for the asynchronous version.
- Parameters
-
stream A IOStream. guid The GUID to use if authenticating as a server or nullptr.flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ create_sync() [4/4]
|
static |
Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream.
If stream is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.
The D-Bus connection will interact with stream from a worker thread. As a result, the caller should not interact with stream after this method has been called, except by calling Glib::object_unref() on it.
If observer is not nullptr it may be used to control the authentication process.
This is a synchronous failable constructor. See g_dbus_connection_new() for the asynchronous version.
- Parameters
-
stream A IOStream. guid The GUID to use if authenticating as a server or nullptr.flags Flags describing how to make the connection. observer A Gio::DBus::AuthObserver or nullptr.cancellable A Cancellable or nullptr.
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ emit_signal()
| void Gio::DBus::Connection::emit_signal | ( | const Glib::ustring & | object_path, |
| const Glib::ustring & | interface_name, | ||
| const Glib::ustring & | signal_name, | ||
| const Glib::ustring & | destination_bus_name = {}, |
||
| const Glib::VariantContainerBase & | parameters = {} |
||
| ) |
Emits a signal.
This can only fail if parameters is not compatible with the D-Bus protocol.
- Parameters
-
object_path Path of remote object. interface_name D-Bus interface to emit a signal on. signal_name The name of the signal to emit. destination_bus_name The unique bus name for the destination for the signal or an empty string to emit to all listeners. parameters A Glib::VariantContainerBase tuple with parameters for the signal or 0if not passing parameters.
- Exceptions
-
Glib::Error.
◆ export_action_group()
| guint Gio::DBus::Connection::export_action_group | ( | const Glib::ustring & | object_path, |
| const Glib::RefPtr< ActionGroup > & | action_group | ||
| ) |
Exports action_group on connection at object_path.
The implemented D-Bus API should be considered private. It is subject to change in the future.
A given object path can only have one action group exported on it. If this constraint is violated, the export will fail and 0 will be returned (with error set accordingly).
You can unexport the action group using Gio::DBusConnection::unexport_action_group() with the return value of this function.
The thread default main context is taken at the time of this call. All incoming action activations and state change requests are reported from this context. Any changes on the action group that cause it to emit signals must also come from this same context. Since incoming action activations and state change requests are rather likely to cause changes on the action group, this effectively limits a given action group to being exported from only one main context.
- Parameters
-
object_path A D-Bus object path. action_group An action group.
- Returns
- The ID of the export (never zero), or 0 in case of failure.
- Exceptions
-
Glib::Error
◆ export_menu_model()
| guint Gio::DBus::Connection::export_menu_model | ( | const Glib::ustring & | object_path, |
| const Glib::RefPtr< MenuModel > & | menu | ||
| ) |
Exports menu on connection at object_path.
The implemented D-Bus API should be considered private. It is subject to change in the future.
An object path can only have one menu model exported on it. If this constraint is violated, the export will fail and 0 will be returned (with error set accordingly).
Exporting menus with sections containing more than G_MENU_EXPORTER_MAX_SECTION_SIZE items is not supported and results in undefined behavior.
You can unexport the menu model using g_dbus_connection_unexport_menu_model() with the return value of this function.
- Parameters
-
object_path A D-Bus object path. menu A MenuModel.
- Returns
- The ID of the export (never zero), or 0 in case of failure.
- Exceptions
-
Glib::Error
◆ flush() [1/3]
| void Gio::DBus::Connection::flush | ( | ) |
Asynchronously flushes the connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using Gio::OutputStream::flush_async()).
This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without flushing the connection, there is no guarantee that the message has been sent to the networking buffers in the OS kernel.
This is an asynchronous method. See flush_sync() for the synchronous version.
◆ flush() [2/3]
Asynchronously flushes the connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using Gio::OutputStream::flush_async()).
This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without flushing the connection, there is no guarantee that the message has been sent to the networking buffers in the OS kernel.
This is an asynchronous method. When the operation is finished, slot will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call flush_finish() to get the result of the operation. See flush_sync() for the synchronous version.
- Parameters
-
slot A SlotAsyncReady to call when the request is satisfied.
◆ flush() [3/3]
| void Gio::DBus::Connection::flush | ( | const SlotAsyncReady & | slot, |
| const Glib::RefPtr< Cancellable > & | cancellable | ||
| ) |
Asynchronously flushes the connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using Gio::OutputStream::flush_async()).
This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without flushing the connection, there is no guarantee that the message has been sent to the networking buffers in the OS kernel.
This is an asynchronous method. When the operation is finished, slot will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call flush_finish() to get the result of the operation. See flush_sync() for the synchronous version.
- Parameters
-
slot A SlotAsyncReady to call when the request is satisfied. cancellable A Cancellable.
◆ flush_finish()
| bool Gio::DBus::Connection::flush_finish | ( | const Glib::RefPtr< AsyncResult > & | res | ) |
Finishes an operation started with g_dbus_connection_flush().
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to g_dbus_connection_flush().
- Returns
trueif the operation succeeded,falseif error is set.
- Exceptions
-
Glib::Error
◆ flush_sync() [1/2]
| void Gio::DBus::Connection::flush_sync | ( | ) |
A flush_sync() convenience overload.
◆ flush_sync() [2/2]
| void Gio::DBus::Connection::flush_sync | ( | const Glib::RefPtr< Cancellable > & | cancellable | ) |
Synchronously flushes connection.
The calling thread is blocked until this is done. See g_dbus_connection_flush() for the asynchronous version of this method and more details about what it does.
- Parameters
-
cancellable A Cancellable or nullptr.
- Exceptions
-
Glib::Error
◆ get() [1/2]
Non-cancellable version of get().
◆ get() [2/2]
|
static |
Asynchronously connects to the message bus specified by bus_type.
When the operation is finished, slot will be invoked. You can then call get_finish() to get the result of the operation.
This is an asynchronous failable function. See get_sync() for the synchronous version.
- Parameters
-
bus_type A BusType. slot A SlotAsyncReady to call when the request is satisfied. cancellable A Cancellable.
◆ get_capabilities()
| CapabilityFlags Gio::DBus::Connection::get_capabilities | ( | ) | const |
Gets the capabilities negotiated with the remote peer.
- Returns
- Zero or more flags from the DBusCapabilityFlags enumeration.
◆ get_exit_on_close()
| bool Gio::DBus::Connection::get_exit_on_close | ( | ) | const |
Gets whether the process is terminated when connection is closed by the remote peer.
See Gio::DBus::Connection::property_exit_on_close() for more details.
- Returns
- Whether the process is terminated when connection is closed by the remote peer.
◆ get_finish()
|
static |
Finishes an operation started with g_bus_get().
The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for bus_type. In the event that you need a private message bus connection, use g_dbus_address_get_for_bus_sync() and g_dbus_connection_new_for_address() with G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT and G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags.
Note that the returned Gio::DBus::Connection object will (usually) have the Gio::DBus::Connection::property_exit_on_close() property set to true.
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to g_bus_get().
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ get_flags()
| ConnectionFlags Gio::DBus::Connection::get_flags | ( | ) | const |
Gets the flags used to construct this connection.
- Returns
- Zero or more flags from the DBusConnectionFlags enumeration.
◆ get_guid()
| std::string Gio::DBus::Connection::get_guid | ( | ) | const |
The GUID of the peer performing the role of server when authenticating.
See Gio::DBus::Connection::property_guid() for more details.
- Returns
- The GUID. Do not free this string, it is owned by connection.
◆ get_last_serial()
| guint32 Gio::DBus::Connection::get_last_serial | ( | ) | const |
Retrieves the last serial number assigned to a Gio::DBus::Message on the current thread.
This includes messages sent via both low-level API such as g_dbus_connection_send_message() as well as high-level API such as g_dbus_connection_emit_signal(), g_dbus_connection_call() or g_dbus_proxy_call().
- Returns
- The last used serial or zero when no message has been sent within the current thread.
◆ get_peer_credentials() [1/2]
| Glib::RefPtr< Credentials > Gio::DBus::Connection::get_peer_credentials | ( | ) |
Gets the credentials of the authenticated peer.
This will always return nullptr unless connection acted as a server (e.g. Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER was passed) when set up and the client passed credentials as part of the authentication process.
In a message bus setup, the message bus is always the server and each application is a client. So this method will always return nullptr for message bus clients.
- Returns
- A Credentials or
nullptrif not available. Do not free this object, it is owned by connection.
◆ get_peer_credentials() [2/2]
| Glib::RefPtr< const Credentials > Gio::DBus::Connection::get_peer_credentials | ( | ) | const |
Gets the credentials of the authenticated peer.
This will always return nullptr unless connection acted as a server (e.g. Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER was passed) when set up and the client passed credentials as part of the authentication process.
In a message bus setup, the message bus is always the server and each application is a client. So this method will always return nullptr for message bus clients.
- Returns
- A Credentials or
nullptrif not available. Do not free this object, it is owned by connection.
◆ get_stream() [1/2]
| Glib::RefPtr< IOStream > Gio::DBus::Connection::get_stream | ( | ) |
Gets the underlying stream used for IO.
While the Gio::DBus::Connection is active, it will interact with this stream from a worker thread, so it is not safe to interact with the stream directly.
- Returns
- The stream used for IO.
◆ get_stream() [2/2]
| Glib::RefPtr< const IOStream > Gio::DBus::Connection::get_stream | ( | ) | const |
Gets the underlying stream used for IO.
While the Gio::DBus::Connection is active, it will interact with this stream from a worker thread, so it is not safe to interact with the stream directly.
- Returns
- The stream used for IO.
◆ get_sync() [1/2]
|
static |
A get_sync() convenience overload.
◆ get_sync() [2/2]
|
static |
Synchronously connects to the message bus specified by bus_type.
Note that the returned object may shared with other callers, e.g. if two separate parts of a process calls this function with the same bus_type, they will share the same object.
This is a synchronous failable function. See g_bus_get() and g_bus_get_finish() for the asynchronous version.
The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for bus_type. In the event that you need a private message bus connection, use g_dbus_address_get_for_bus_sync() and g_dbus_connection_new_for_address() with G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT and G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags.
Note that the returned Gio::DBus::Connection object will (usually) have the Gio::DBus::Connection::property_exit_on_close() property set to true.
- Parameters
-
bus_type A BusType. cancellable A Cancellable or nullptr.
- Returns
- A Gio::DBus::Connection or
nullptrif error is set. Free with Glib::object_unref().
- Exceptions
-
Glib::Error
◆ get_type()
Get the GType for this class, for use with the underlying GObject type system.
◆ get_unique_name()
| Glib::ustring Gio::DBus::Connection::get_unique_name | ( | ) | const |
Gets the unique name of connection as assigned by the message bus.
This can also be used to figure out if connection is a message bus connection.
- Returns
- The unique name or
nullptrif connection is not a message bus connection. Do not free this string, it is owned by connection.
◆ gobj() [1/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj() [2/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj_copy()
| GDBusConnection * Gio::DBus::Connection::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
◆ is_closed()
| bool Gio::DBus::Connection::is_closed | ( | ) | const |
Gets whether connection is closed.
- Returns
trueif the connection is closed,falseotherwise.
◆ operator=()
|
noexcept |
◆ property_capabilities()
| Glib::PropertyProxy_ReadOnly< CapabilityFlags > Gio::DBus::Connection::property_capabilities | ( | ) | const |
Flags from the DBusCapabilityFlags enumeration representing connection features negotiated with the other peer.
Default value: Gio::DBus::CapabilityFlags::NONE
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_closed()
| Glib::PropertyProxy_ReadOnly< bool > Gio::DBus::Connection::property_closed | ( | ) | const |
A boolean specifying whether the connection has been closed.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_exit_on_close() [1/2]
| Glib::PropertyProxy< bool > Gio::DBus::Connection::property_exit_on_close | ( | ) |
A boolean specifying whether the process will be terminated (by calling raise(SIGTERM)) if the connection is closed by the remote peer.
Note that Gio::DBus::Connection objects returned by g_bus_get_finish() and g_bus_get_sync() will (usually) have this property set to true.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
◆ property_exit_on_close() [2/2]
| Glib::PropertyProxy_ReadOnly< bool > Gio::DBus::Connection::property_exit_on_close | ( | ) | const |
A boolean specifying whether the process will be terminated (by calling raise(SIGTERM)) if the connection is closed by the remote peer.
Note that Gio::DBus::Connection objects returned by g_bus_get_finish() and g_bus_get_sync() will (usually) have this property set to true.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_flags()
| Glib::PropertyProxy_ReadOnly< ConnectionFlags > Gio::DBus::Connection::property_flags | ( | ) | const |
Flags from the DBusConnectionFlags enumeration.
Default value: Gio::DBus::ConnectionFlags::NONE
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_guid()
| Glib::PropertyProxy_ReadOnly< std::string > Gio::DBus::Connection::property_guid | ( | ) | const |
The GUID of the peer performing the role of server when authenticating.
If you are constructing a Gio::DBus::Connection and pass Gio::DBus::ConnectionFlags::AUTHENTICATION_SERVER in the Gio::DBus::Connection::property_flags() property then you must also set this property to a valid guid.
If you are constructing a Gio::DBus::Connection and pass Gio::DBus::ConnectionFlags::AUTHENTICATION_CLIENT in the Gio::DBus::Connection::property_flags() property you will be able to read the GUID of the other peer here after the connection has been successfully initialized.
Note that the D-Bus specification uses the term ‘UUID’ to refer to this, whereas GLib consistently uses the term ‘GUID’ for historical reasons.
Despite its name, the format of Gio::DBus::Connection::property_guid() does not follow RFC 4122 or the Microsoft GUID format.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_stream()
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< IOStream > > Gio::DBus::Connection::property_stream | ( | ) | const |
The underlying IOStream used for I/O.
If this is passed on construction and is a SocketConnection, then the corresponding Socket will be put into non-blocking mode.
While the Gio::DBus::Connection is active, it will interact with this stream from a worker thread, so it is not safe to interact with the stream directly.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_unique_name()
| Glib::PropertyProxy_ReadOnly< Glib::ustring > Gio::DBus::Connection::property_unique_name | ( | ) | const |
The unique name as assigned by the message bus or nullptr if the connection is not open or not a message bus connection.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ register_object() [1/3]
| guint Gio::DBus::Connection::register_object | ( | const Glib::ustring & | object_path, |
| const Glib::RefPtr< InterfaceInfo > & | interface_info | ||
| ) |
Registers exported objects at object_path with the D-Bus interface that is described in interface_info.
This method overload, which does not take a VTable, is useful for marker interfaces.
If an existing slot is already registered at object_path and interface_name, then a Gio::Error is thrown.
GDBus automatically implements the standard D-Bus interfaces org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable and org.freedesktop.Peer, so you don't have to implement those for the objects you export.
- Parameters
-
object_path The object path to register at. interface_info Introspection data for the interface.
- Returns
- A registration id (never 0) that can be used with unregister_object() if no Glib::Error is thrown.
- Exceptions
-
Gio::Error.
◆ register_object() [2/3]
| guint Gio::DBus::Connection::register_object | ( | const Glib::ustring & | object_path, |
| const Glib::RefPtr< InterfaceInfo > & | interface_info, | ||
| const InterfaceVTable & | vtable | ||
| ) |
Registers slots for exported objects at object_path with the D-Bus interface that is described in interface_info.
Calls to slots in vtable will happen in the thread-default main loop of the thread you are calling this method from.
Note that all Glib::VariantBase values passed to functions in vtable will match the signature given in interface_info - if a remote caller passes incorrect values, the org.freedesktop.DBus.Error.InvalidArgs is returned to the remote caller.
Additionally, if the remote caller attempts to invoke methods or access properties not mentioned in interface_info the org.freedesktop.DBus.Error.UnknownMethod resp. org.freedesktop.DBus.Error.InvalidArgs errors are returned to the caller.
It is considered a programming error if the InterfaceVTable::SlotInterfaceGetProperty slot in vtable returns a Glib::VariantBase of incorrect type.
If an existing slot is already registered at object_path and interface_name, then a Gio::Error is thrown.
GDBus automatically implements the standard D-Bus interfaces org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable and org.freedesktop.Peer, so you don't have to implement those for the objects you export. You can implement org.freedesktop.DBus.Properties yourself, e.g. to handle getting and setting of properties asynchronously.
- Parameters
-
object_path The object path to register at. interface_info Introspection data for the interface. vtable An InterfaceVTable to call into.
- Returns
- A registration id (never 0) that can be used with unregister_object() if no Glib::Error is thrown.
- Exceptions
-
Gio::Error.
◆ register_object() [3/3]
| guint Gio::DBus::Connection::register_object | ( | const Glib::ustring & | object_path, |
| const Glib::RefPtr< InterfaceInfo > & | interface_info, | ||
| const InterfaceVTable::SlotInterfaceMethodCall & | slot_method_call, | ||
| const InterfaceVTable::SlotInterfaceGetProperty & | slot_get_property = {}, |
||
| const InterfaceVTable::SlotInterfaceSetProperty & | slot_set_property = {} |
||
| ) |
Registers slots for exported objects at object_path with the D-Bus interface that is described in interface_info.
Calls to the slots will happen in the thread-default main loop of the thread you are calling this method from.
Note that all Glib::VariantBase values passed to the slots will match the signature given in interface_info - if a remote caller passes incorrect values, the org.freedesktop.DBus.Error.InvalidArgs is returned to the remote caller.
Additionally, if the remote caller attempts to invoke methods or access properties not mentioned in interface_info the org.freedesktop.DBus.Error.UnknownMethod resp. org.freedesktop.DBus.Error.InvalidArgs errors are returned to the caller.
It is considered a programming error if the InterfaceVTable::SlotInterfaceGetProperty slot returns a Glib::VariantBase of incorrect type.
If an existing slot is already registered at object_path and interface_name, then a Gio::Error is thrown.
GDBus automatically implements the standard D-Bus interfaces org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable and org.freedesktop.Peer, so you don't have to implement those for the objects you export. You can implement org.freedesktop.DBus.Properties yourself, e.g. to handle getting and setting of properties asynchronously.
- Parameters
-
object_path The object path to register at. interface_info Introspection data for the interface. slot_method_call The slot for handling incoming method calls. slot_get_property The slot for getting a property. slot_set_property The slot for setting a property.
- Returns
- A registration id (never 0) that can be used with unregister_object() if no Glib::Error is thrown.
- Exceptions
-
Gio::Error.
◆ register_subtree()
| guint Gio::DBus::Connection::register_subtree | ( | const Glib::ustring & | object_path, |
| const SubtreeVTable & | vtable, | ||
| SubtreeFlags | flags = Gio::DBus::SubtreeFlags::NONE |
||
| ) |
Registers a whole subtree of “dynamic” objects.
Copies of the enumerate and introspection slots usted to create vtable are used to convey, to remote callers, what nodes exist in the subtree rooted by object_path.
When handling remote calls into any node in the subtree, first the enumerate slot is used to check if the node exists. If the node exists or the Gio::DBus::SubtreeFlags::DISPATCH_TO_UNENUMERATED_NODES flag is set the introspection slot is used to check if the node supports the requested method. If so, the dispatch function is used to determine where to dispatch the call. The collected InterfaceVTable will be used to call into the interface vtable for processing the request.
All calls into user-provided code will be invoked in the thread-default main loop of the thread you are calling this method from.
If an existing subtree is already registered at object_path or then a Gio::Error is thrown.
Note that it is valid to register regular objects (using register_object()) in a subtree registered with register_subtree() - if so, the subtree handler is tried as the last resort. One way to think about a subtree handler is to consider it a “fallback handler” for object paths not registered via register_object().
- Parameters
-
object_path The object path to register the subtree at. vtable A SubtreeVTable to enumerate, introspect and dispatch nodes in the subtree. flags Flags used to fine tune the behavior of the subtree.
- Returns
- A subtree registration id (never 0) that can be used with unregister_subtree() if no Glib::Error is thrown.
- Exceptions
-
Gio::Error.
◆ remove_filter()
Removes a filter.
Note that since filters run in a different thread, there is a race condition where it is possible that the filter will be running even after calling g_dbus_connection_remove_filter(), so you cannot just free data that the filter might be using. Instead, you should pass a DestroyNotify to g_dbus_connection_add_filter(), which will be called when it is guaranteed that the data is no longer needed.
- Parameters
-
filter_id An identifier obtained from g_dbus_connection_add_filter().
◆ send_message() [1/2]
| bool Gio::DBus::Connection::send_message | ( | const Glib::RefPtr< Message > & | message, |
| SendMessageFlags | flags, | ||
| guint32 & | out_serial | ||
| ) |
Asynchronously sends message to the peer represented by connection.
Unless flags contain the Gio::DBus::SendMessageFlags::PRESERVE_SERIAL flag, the serial number will be assigned by connection and set on message via g_dbus_message_set_serial(). If out_serial is not nullptr, then the serial number used will be written to this location prior to submitting the message to the underlying transport. While it has a volatile qualifier, this is a historical artifact and the argument passed to it should not be volatile.
If connection is closed then the operation will fail with Gio::Error::CLOSED. If message is not well-formed, the operation fails with Gio::Error::INVALID_ARGUMENT.
See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.
Note that message must be unlocked, unless flags contain the Gio::DBus::SendMessageFlags::PRESERVE_SERIAL flag.
- Parameters
-
message A Gio::DBus::Message. flags Flags affecting how the message is sent. out_serial Return location for serial number assigned to message when sending it or nullptr.
- Returns
trueif the message was well-formed and queued for transmission,falseif error is set.
- Exceptions
-
Glib::Error
◆ send_message() [2/2]
| bool Gio::DBus::Connection::send_message | ( | const Glib::RefPtr< Message > & | message, |
| SendMessageFlags | flags = Gio::DBus::SendMessageFlags::NONE |
||
| ) |
A send_message() without an "out_serial" parameter.
◆ send_message_with_reply() [1/2]
| void Gio::DBus::Connection::send_message_with_reply | ( | const Glib::RefPtr< Message > & | message, |
| int | timeout_msec, | ||
| const SlotAsyncReady & | slot | ||
| ) |
Non-cancellable version of send_message_with_reply().
◆ send_message_with_reply() [2/2]
| void Gio::DBus::Connection::send_message_with_reply | ( | const Glib::RefPtr< Message > & | message, |
| int | timeout_msec, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable | ||
| ) |
Asynchronously sends message to the peer represented by the connection.
Unless flags contain the Gio::DBus::SendMessageFlags::PRESERVE_SERIAL flag, the serial number will be assigned by the connection and set on message via Gio::DBus::Message::set_serial().
If the connection is closed then the operation will fail with Gio::Error::CLOSED. If cancellable is canceled, the operation will fail with Gio::Error::CANCELLED. If message is not well-formed, the operation fails with Gio::Error::INVALID_ARGUMENT.
This is an asynchronous method. When the operation is finished, slot will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call send_message_with_reply_finish() to get the result of the operation. See send_message_with_reply_sync() for the synchronous version.
Note that message must be unlocked, unless flags contain the Gio::DBus::SendMessageFlags::PRESERVE_SERIAL flag.
See the C API docs for examples.
- Parameters
-
message A Message. timeout_msec The timeout in milliseconds or -1 to use the default timeout. slot A SlotAsyncReady to call when the request is satisfied. cancellable A Cancellable.
◆ send_message_with_reply_finish()
| Glib::RefPtr< Message > Gio::DBus::Connection::send_message_with_reply_finish | ( | const Glib::RefPtr< AsyncResult > & | res | ) |
Finishes an operation started with g_dbus_connection_send_message_with_reply().
Note that error is only set if a local in-process error occurred. That is to say that the returned Gio::DBus::Message object may be of type Gio::DBus::MessageType::ERROR. Use g_dbus_message_to_gerror() to transcode this to a Error.
See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors.
- Parameters
-
res A AsyncResult obtained from the SlotAsyncReady passed to g_dbus_connection_send_message_with_reply().
- Returns
- A locked Gio::DBus::Message or
nullptrif error is set.
- Exceptions
-
Glib::Error
◆ send_message_with_reply_sync() [1/2]
| Glib::RefPtr< Message > Gio::DBus::Connection::send_message_with_reply_sync | ( | const Glib::RefPtr< Message > & | message, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| gint | timeout_msec | ||
| ) |
Synchronously sends message to the peer represented by the connection and blocks the calling thread until a reply is received or the timeout is reached.
See send_message_with_reply() for the asynchronous version of this method.
Unless flags contain the Gio::DBus::SendMessageFlags::PRESERVE_SERIAL flag, the serial number will be assigned by the connection and set on message via Gio::DBus::Message::set_serial().
If the connection is closed then the operation will fail with Gio::Error::CLOSED. If cancellable is canceled, the operation will fail with Gio::Error::CANCELLED. If message is not well-formed, the operation fails with Gio::Error::INVALID_ARGUMENT.
Note that a Glib::Error is thrown if a local in-process error occured. That is to say that the returned Message object may be of type Gio::DBus::MessageType::ERROR. Use Gio::DBus::Message::to_exception() to transcode this to a Glib::Error.
See the C API docs for examples.
Note that message must be unlocked, unless flags contain the Gio::DBus::SendMessageFlags::PRESERVE_SERIAL flag.
- Parameters
-
message A Message. cancellable A Cancellable. timeout_msec The timeout in milliseconds or -1 to use the default timeout.
- Returns
- A locked Message that is the reply to message or
0if a Glib::Error is thrown.
- Exceptions
-
Glib::Error.
◆ send_message_with_reply_sync() [2/2]
| Glib::RefPtr< Message > Gio::DBus::Connection::send_message_with_reply_sync | ( | const Glib::RefPtr< Message > & | message, |
| gint | timeout_msec | ||
| ) |
A non-cancellable version of send_message_with_reply_sync().
◆ set_exit_on_close()
Sets whether the process should be terminated when connection is closed by the remote peer.
See Gio::DBus::Connection::property_exit_on_close() for more details.
Note that this function should be used with care. Most modern UNIX desktops tie the notion of a user session with the session bus, and expect all of a user's applications to quit when their bus connection goes away. If you are setting exit_on_close to false for the shared session bus connection, you should make sure that your application exits when the user session ends.
- Parameters
-
exit_on_close Whether the process should be terminated when connection is closed by the remote peer.
◆ signal_closed()
| Glib::SignalProxy< void(bool, const Glib::Error &)> Gio::DBus::Connection::signal_closed | ( | ) |
- Slot Prototype:
void on_my_closed(bool remote_peer_vanished, const Glib::Error& error)
Flags: Run Last
Emitted when the connection is closed.
The cause of this event can be
- If g_dbus_connection_close() is called. In this case remote_peer_vanished is set to
falseand error isnullptr. - If the remote peer closes the connection. In this case remote_peer_vanished is set to
trueand error is set. - If the remote peer sends invalid or malformed data. In this case remote_peer_vanished is set to
falseand error is set.
Upon receiving this signal, you should give up your reference to connection. You are guaranteed that this signal is emitted only once.
- Parameters
-
remote_peer_vanished trueif connection is closed because the remote peer closed its end of the connection.error A Error with more details about the event or nullptr.
◆ signal_subscribe()
| guint Gio::DBus::Connection::signal_subscribe | ( | const SlotSignal & | slot, |
| const Glib::ustring & | sender = {}, |
||
| const Glib::ustring & | interface_name = {}, |
||
| const Glib::ustring & | member = {}, |
||
| const Glib::ustring & | object_path = {}, |
||
| const Glib::ustring & | arg0 = {}, |
||
| SignalFlags | flags = Gio::DBus::SignalFlags::NONE |
||
| ) |
Subscribes to signals on the connection and invokes slot with a whenever the signal is received.
Note that slot will be invoked in the thread-default main loop of the thread you are calling this method from.
If the connection is not a message bus connection, sender must be an empty string.
If sender is a well-known name note that slot is invoked with the unique name for the owner of sender, not the well-known name as one would expect. This is because the message bus rewrites the name. As such, to avoid certain race conditions, users should be tracking the name owner of the well-known name and use that when processing the received signal.
- Parameters
-
slot Slot to invoke when there is a signal matching the requested data. sender Sender name to match on (unique or well-known name) or an empty string to listen from all senders. interface_name D-Bus interface name to match on or an empty string to match on all interfaces. member D-Bus signal name to match on or an empty string to match on all signals. object_path Object path to match on or an empty string to match on all object paths. arg0 Contents of first string argument to match on or an empty string to match on all kinds of arguments. flags Flags describing how to subscribe to the signal (currently unused).
- Returns
- A subscription identifier that can be used with signal_unsubscribe().
◆ signal_unsubscribe()
Unsubscribes from signals.
Note that there may still be D-Bus traffic to process (relating to this signal subscription) in the current thread-default MainContext after this function has returned. You should continue to iterate the MainContext until the DestroyNotify function passed to g_dbus_connection_signal_subscribe() is called, in order to avoid memory leaks through callbacks queued on the MainContext after it’s stopped being iterated. Alternatively, any idle source with a priority lower than G_PRIORITY_DEFAULT that was scheduled after unsubscription, also indicates that all resources of this subscription are released.
- Parameters
-
subscription_id A subscription id obtained from g_dbus_connection_signal_subscribe().
◆ start_message_processing()
| void Gio::DBus::Connection::start_message_processing | ( | ) |
If connection was created with Gio::DBus::ConnectionFlags::DELAY_MESSAGE_PROCESSING, this method starts processing messages.
Does nothing on if connection wasn't created with this flag or if the method has already been called.
◆ unexport_action_group()
Reverses the effect of a previous call to Gio::DBusConnection::export_action_group().
It is an error to call this function with an ID that wasn’t returned from Gio::DBusConnection::export_action_group() or to call it with the same ID more than once.
- Parameters
-
export_id The ID from Gio::DBusConnection::export_action_group().
◆ unexport_menu_model()
Reverses the effect of a previous call to g_dbus_connection_export_menu_model().
It is an error to call this function with an ID that wasn't returned from g_dbus_connection_export_menu_model() or to call it with the same ID more than once.
- Parameters
-
export_id The ID from g_dbus_connection_export_menu_model().
◆ unregister_object()
| bool Gio::DBus::Connection::unregister_object | ( | guint | registration_id | ) |
Unregisters an object.
- Parameters
-
registration_id A registration id obtained from g_dbus_connection_register_object().
- Returns
trueif the object was unregistered,falseotherwise.
◆ unregister_subtree()
| bool Gio::DBus::Connection::unregister_subtree | ( | guint | registration_id | ) |
Unregisters a subtree.
- Parameters
-
registration_id A subtree registration id obtained from g_dbus_connection_register_subtree().
- Returns
trueif the subtree was unregistered,falseotherwise.
Friends And Related Symbol Documentation
◆ wrap()
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.
