glibmm: Gio::DBus::Server Class Reference

This is a helper for listening to and accepting D-Bus connections. More...

#include <giomm/dbusserver.h>

Inheritance diagram for Gio::DBus::Server:

[legend]

Public Types
enum class	Flags { NONE = 0x0 , RUN_IN_THREAD = (1<<0) , AUTHENTICATION_ALLOW_ANONYMOUS = (1<<1) , AUTHENTICATION_REQUIRE_SAME_USER = (1<<2) }

Public Types inherited from Glib::Object
using	DestroyNotify = void(*)(gpointer data)

Public Member Functions
	Server (Server &&src) noexcept

Server &	operator= (Server &&src) noexcept

	~Server () noexcept override

GDBusServer *	gobj ()
	Provides access to the underlying C GObject.

const GDBusServer *	gobj () const
	Provides access to the underlying C GObject.

GDBusServer *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void	start ()
	Starts server.

void	stop ()
	Stops server.

bool	is_active () const
	Gets whether server is active.

std::string	get_guid () const
	Gets the GUID for server, as provided to g_dbus_server_new_sync().

Flags	get_flags () const
	Gets the flags for server.

std::string	get_client_address () const
	Gets a D-Bus address string that can be used by clients to connect to server.

Glib::PropertyProxy_ReadOnly< bool >	property_active () const
	Whether the server is currently active.

Glib::PropertyProxy_ReadOnly< std::string >	property_address () const
	The D-Bus address to listen on.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< AuthObserver > >	property_authentication_observer () const
	A Gio::DBus::AuthObserver object to assist in the authentication process or `nullptr`.

Glib::PropertyProxy_ReadOnly< std::string >	property_client_address () const
	The D-Bus address that clients can use.

Glib::PropertyProxy_ReadOnly< Flags >	property_flags () const
	Flags from the Gio::DBus::Server::Flags enumeration.

Glib::PropertyProxy_ReadOnly< std::string >	property_guid () const
	The GUID of the server.

Glib::SignalProxy< bool(const Glib::RefPtr< Connection > &)>	signal_new_connection ()

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark & key)

void	set_data (const Quark & key, void *data)

void	set_data_with_c_callback (const Quark & key, void *data, GDestroyNotify notify)

void	set_data (const Quark & key, void *data, DestroyNotify notify)
	Prefer set_data_with_c_callback() with a callback with C linkage.

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
	You probably want to use a specific property_*() accessor method instead.

void	get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
void	set_property (const Glib::ustring & property_name, const PropertyType & value)
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
void	get_property (const Glib::ustring & property_name, PropertyType & value) const
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.

sigc::connection	connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot)
	You can use the signal_changed() signal of the property proxy instead.

sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot)
	You can use the signal_changed() signal of the property proxy instead.

void	freeze_notify ()
	Increases the freeze count on object.

void	thaw_notify ()
	Reverts the effect of a previous call to freeze_notify().

virtual void	reference () const
	Increment the reference count for this object.

virtual void	unreference () const
	Decrement the reference count for this object.

GObject *	gobj ()
	Provides access to the underlying C GObject.

const GObject *	gobj () const
	Provides access to the underlying C GObject.

GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.

Public Member Functions inherited from Gio::Initable
	Initable (Initable &&src) noexcept

Initable &	operator= (Initable &&src) noexcept

	~Initable () noexcept override

GInitable *	gobj ()
	Provides access to the underlying C GObject.

const GInitable *	gobj () const
	Provides access to the underlying C GObject.

Public Member Functions inherited from Glib::Interface
	Interface ()
	A Default constructor.

	Interface (Interface &&src) noexcept

Interface &	operator= (Interface &&src) noexcept

	Interface (const Glib::Interface_Class &interface_class)
	Called by constructors of derived classes.

	Interface (GObject *castitem)
	Called by constructors of derived classes.

	~Interface () noexcept override

	Interface (const Interface &)=delete

Interface &	operator= (const Interface &)=delete

GObject *	gobj ()

const GObject *	gobj () const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< Server >	create_sync (const std::string &address, const std::string &guid, const Glib::RefPtr< AuthObserver > &observer, const Glib::RefPtr< Cancellable > &cancellable, Flags flags=Gio::DBus::Server::Flags::NONE)
	Creates a new D-Bus server that listens on the first address in address that works.

static Glib::RefPtr< Server >	create_sync (const std::string &address, const std::string &guid, const Glib::RefPtr< Cancellable > &cancellable, Flags flags=Gio::DBus::Server::Flags::NONE)
	Creates a new D-Bus server that listens on the first address in address that works.

static Glib::RefPtr< Server >	create_sync (const std::string &address, const std::string &guid, const Glib::RefPtr< AuthObserver > &observer, Flags flags=Gio::DBus::Server::Flags::NONE)
	Non-cancellable version of create_sync().

static Glib::RefPtr< Server >	create_sync (const std::string &address, const std::string &guid, Flags flags=Gio::DBus::Server::Flags::NONE)
	Non-cancellable version of create_sync().

Static Public Member Functions inherited from Gio::Initable
static void	add_interface (GType gtype_implementer)

static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Protected Member Functions
	Server (const std::string &address, const std::string &guid, const Glib::RefPtr< AuthObserver > &observer, const Glib::RefPtr< Cancellable > &cancellable, Flags flags)

	Server (const std::string &address, const std::string &guid, const Glib::RefPtr< Cancellable > &cancellable, Flags flags)

	Server (const std::string &address, const std::string &guid, const Glib::RefPtr< AuthObserver > &observer, Flags flags)

	Server (const std::string &address, const std::string &guid, Flags flags)

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

	~Object () noexcept override

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()
	This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.

	ObjectBase (const char *custom_type_name)
	A derived constructor always overrides this choice.

	ObjectBase (const std::type_info &custom_type_info)
	This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Protected Member Functions inherited from Gio::Initable
	Initable ()
	You should derive from this class to use it.

void	init (const Glib::RefPtr< Cancellable > &cancellable)
	Initializes the object implementing the interface.

void	init ()
	A init() convenience overload.

virtual bool	init_vfunc (const Glib::RefPtr< Cancellable > &cancellable, GError **error)

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::DBus::Server >	wrap (GDBusServer *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.

Detailed Description

This is a helper for listening to and accepting D-Bus connections.

Since Server derives from Initiable, its constructors can throw an exception if construction fails.

This can be used to create a new D-Bus server, allowing two peers to use the D-Bus protocol for their own specialized communication. A server instance provided in this way will not perform message routing or implement the org.freedesktop.DBus interface.

To just export an object on a well-known name on a message bus, such as the session or system bus, you should instead use Gio::DBus::own_name().

Since glibmm 2.28:

Member Enumeration Documentation

◆ Flags

enum class Gio::DBus::Server::Flags

strong

Enumerator
NONE	No flags set.
RUN_IN_THREAD	All Gio::DBus::Server::signal_new_connection() signals will run in separated dedicated threads (see signal for details).
AUTHENTICATION_ALLOW_ANONYMOUS	Allow the anonymous authentication method.
AUTHENTICATION_REQUIRE_SAME_USER	Require the UID of the peer to be the same as the UID of the server when authenticating. (Since: 2.68).

Constructor & Destructor Documentation

◆ Server() [1/5]

Gio::DBus::Server::Server ( Server && src )

noexcept

◆ ~Server()

Gio::DBus::Server::~Server ( )

overridenoexcept

◆ Server() [2/5]

Gio::DBus::Server::Server	(	const std::string &	address,
		const std::string &	guid,
		const Glib::RefPtr< AuthObserver > &	observer,
		const Glib::RefPtr< Cancellable > &	cancellable,
		Flags	flags
	)

protected

◆ Server() [3/5]

Gio::DBus::Server::Server	(	const std::string &	address,
		const std::string &	guid,
		const Glib::RefPtr< Cancellable > &	cancellable,
		Flags	flags
	)

protected

◆ Server() [4/5]

Gio::DBus::Server::Server	(	const std::string &	address,
		const std::string &	guid,
		const Glib::RefPtr< AuthObserver > &	observer,
		Flags	flags
	)

protected

◆ Server() [5/5]

Gio::DBus::Server::Server	(	const std::string &	address,
		const std::string &	guid,
		Flags	flags
	)

protected

Member Function Documentation

◆ create_sync() [1/4]

static Glib::RefPtr< Server > Gio::DBus::Server::create_sync	(	const std::string &	address,
		const std::string &	guid,
		const Glib::RefPtr< AuthObserver > &	observer,
		const Glib::RefPtr< Cancellable > &	cancellable,
		Flags	flags = `Gio::DBus::Server::Flags::NONE`
	)

static

Creates a new D-Bus server that listens on the first address in address that works.

Once constructed, you can use g_dbus_server_get_client_address() to get a D-Bus address string that clients can use to connect.

To have control over the available authentication mechanisms and the users that are authorized to connect, it is strongly recommended to provide a non-nullptr Gio::DBus::AuthObserver.

Connect to the Gio::DBus::Server::signal_new_connection() signal to handle incoming connections.

The returned Gio::DBus::Server isn't active - you have to start it with g_dbus_server_start().

Gio::DBus::Server is used in this [example][gdbus-peer-to-peer].

This is a synchronous failable constructor. There is currently no asynchronous version.

Since glibmm 2.26:

Parameters

address	A D-Bus address.
flags	Flags from the Gio::DBus::Server::Flags enumeration.
guid	A D-Bus GUID.
observer	A Gio::DBus::AuthObserver or `nullptr`.
cancellable	A Cancellable or `nullptr`.

Returns: A Gio::DBus::Server or nullptr if error is set. Free with Glib::object_unref().

Exceptions

Glib::Error.

◆ create_sync() [2/4]

static Glib::RefPtr< Server > Gio::DBus::Server::create_sync	(	const std::string &	address,
		const std::string &	guid,
		const Glib::RefPtr< AuthObserver > &	observer,
		Flags	flags = `Gio::DBus::Server::Flags::NONE`
	)

static

Non-cancellable version of create_sync().

◆ create_sync() [3/4]

static Glib::RefPtr< Server > Gio::DBus::Server::create_sync	(	const std::string &	address,
		const std::string &	guid,
		const Glib::RefPtr< Cancellable > &	cancellable,
		Flags	flags = `Gio::DBus::Server::Flags::NONE`
	)

static

Creates a new D-Bus server that listens on the first address in address that works.

Once constructed, you can use g_dbus_server_get_client_address() to get a D-Bus address string that clients can use to connect.

To have control over the available authentication mechanisms and the users that are authorized to connect, it is strongly recommended to provide a non-nullptr Gio::DBus::AuthObserver.

Connect to the Gio::DBus::Server::signal_new_connection() signal to handle incoming connections.

The returned Gio::DBus::Server isn't active - you have to start it with g_dbus_server_start().

Gio::DBus::Server is used in this [example][gdbus-peer-to-peer].

This is a synchronous failable constructor. There is currently no asynchronous version.

Since glibmm 2.26:

Parameters

address	A D-Bus address.
flags	Flags from the Gio::DBus::Server::Flags enumeration.
guid	A D-Bus GUID.
observer	A Gio::DBus::AuthObserver or `nullptr`.
cancellable	A Cancellable or `nullptr`.

Returns: A Gio::DBus::Server or nullptr if error is set. Free with Glib::object_unref().

Exceptions

Glib::Error.

◆ create_sync() [4/4]

static Glib::RefPtr< Server > Gio::DBus::Server::create_sync	(	const std::string &	address,
		const std::string &	guid,
		Flags	flags = `Gio::DBus::Server::Flags::NONE`
	)

static

Non-cancellable version of create_sync().

◆ get_client_address()

std::string Gio::DBus::Server::get_client_address ( ) const

Gets a D-Bus address string that can be used by clients to connect to server.

This is valid and non-empty if initializing the Gio::DBus::Server succeeded.

Since glibmm 2.26:

Returns: A D-Bus address string. Do not free, the string is owned by server.

◆ get_flags()

Flags Gio::DBus::Server::get_flags ( ) const

Gets the flags for server.

Since glibmm 2.26:

Returns: A set of flags from the Gio::DBus::Server::Flags enumeration.

◆ get_guid()

std::string Gio::DBus::Server::get_guid ( ) const

Gets the GUID for server, as provided to g_dbus_server_new_sync().

Since glibmm 2.26:

Returns: A D-Bus GUID. Do not free this string, it is owned by server.

◆ get_type()

static GType Gio::DBus::Server::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GDBusServer * Gio::DBus::Server::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GDBusServer * Gio::DBus::Server::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GDBusServer * Gio::DBus::Server::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ is_active()

bool Gio::DBus::Server::is_active ( ) const

Gets whether server is active.

Since glibmm 2.26:

Returns: true if server is active, false otherwise.

◆ operator=()

Server & Gio::DBus::Server::operator= ( Server && src )

noexcept

◆ property_active()

Glib::PropertyProxy_ReadOnly< bool > Gio::DBus::Server::property_active ( ) const

Whether the server is currently active.

Since glibmm 2.26:

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_address()

Glib::PropertyProxy_ReadOnly< std::string > Gio::DBus::Server::property_address ( ) const

The D-Bus address to listen on.

Since glibmm 2.26:

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_authentication_observer()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< AuthObserver > > Gio::DBus::Server::property_authentication_observer ( ) const

A Gio::DBus::AuthObserver object to assist in the authentication process or nullptr.

Since glibmm 2.26:

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_client_address()

Glib::PropertyProxy_ReadOnly< std::string > Gio::DBus::Server::property_client_address ( ) const

The D-Bus address that clients can use.

Since glibmm 2.26:

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_flags()

Glib::PropertyProxy_ReadOnly< Flags > Gio::DBus::Server::property_flags ( ) const

Flags from the Gio::DBus::Server::Flags enumeration.

Since glibmm 2.26:

Default value: Gio::DBus::Server::Flags::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::Server::property_guid ( ) const

The GUID of the server.

See Gio::DBus::Connection::property_guid() for more details.

Since glibmm 2.26:

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.

◆ signal_new_connection()

Glib::SignalProxy< bool(const Glib::RefPtr< Connection > &)> Gio::DBus::Server::signal_new_connection ( )

Slot Prototype:: bool on_my_new_connection(const Glib::RefPtr<Connection>& connection)

Flags: Run Last

Emitted when a new authenticated connection has been made. Use g_dbus_connection_get_peer_credentials() to figure out what identity (if any), was authenticated.

If you want to accept the connection, take a reference to the connection object and return true. When you are done with the connection call g_dbus_connection_close() and give up your reference. Note that the other peer may disconnect at any time - a typical thing to do when accepting a connection is to listen to the Gio::DBus::Connection::signal_closed() signal.

If Gio::DBus::Server::property_flags() contains Gio::DBus::Server::Flags::RUN_IN_THREAD then the signal is emitted in a new thread dedicated to the connection. Otherwise the signal is emitted in the [thread-default main context][g-main-context-push-thread-default] of the thread that server was constructed in.

You are guaranteed that signal handlers for this signal runs before incoming messages on connection are processed. This means that it's suitable to call g_dbus_connection_register_object() or similar from the signal handler.

Since glibmm 2.26:

Parameters

connection A Gio::DBus::Connection for the new connection.

Returns: true to claim connection, false to let other handlers run.

◆ start()

void Gio::DBus::Server::start ( )

Starts server.

Since glibmm 2.26:

◆ stop()

void Gio::DBus::Server::stop ( )

Stops server.

Since glibmm 2.26:

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gio::DBus::Server > wrap	(	GDBusServer *	object,
		bool	take_copy = `false`
	)

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.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ Server() [1/5]

◆ ~Server()

◆ Server() [2/5]

◆ Server() [3/5]

◆ Server() [4/5]

◆ Server() [5/5]

Member Function Documentation

◆ create_sync() [1/4]

◆ create_sync() [2/4]

◆ create_sync() [3/4]

◆ create_sync() [4/4]

◆ get_client_address()

◆ get_flags()

◆ get_guid()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ is_active()

◆ operator=()

◆ property_active()

◆ property_address()

◆ property_authentication_observer()

◆ property_client_address()

◆ property_flags()

◆ property_guid()

◆ signal_new_connection()

◆ start()

◆ stop()

Friends And Related Symbol Documentation

◆ wrap()