Class

PlumaMessageBus

since: 1.0

Description

class Pluma.MessageBus : GObject.Object
{
  priv: PlumaMessageBusPrivate*
}
No description available.

Available since: 1.0

Ancestors

Constructors

pluma_message_bus_new

Create a new message bus. Use pluma_message_bus_get_default() to get the default, application wide, message bus. Creating a new bus is useful for associating a specific bus with for instance a PlumaWindow.

since: 1.0

Functions

pluma_message_bus_get_default

Get the default application PlumaMessageBus.

since: 1.0

Instance methods

pluma_message_bus_block

Blocks evoking the callback specified by id. Unblock the callback by using pluma_message_bus_unblock().

since: 1.0

pluma_message_bus_block_by_func

Blocks evoking the callback that matches provided callback and userdata. Unblock the callback using pluma_message_unblock_by_func().

since: 1.0

pluma_message_bus_connect

Connect a callback handler to be evoked when message method at object_path is sent over the bus.

since: 1.0

pluma_message_bus_disconnect

Disconnects a previously connected message callback.

since: 1.0

pluma_message_bus_disconnect_by_func

Disconnects a previously connected message callback by matching the provided callback function and userdata. See also pluma_message_bus_disconnect().

since: 1.0

pluma_message_bus_foreach

Calls func for each message type registered on the bus.

since: 1.0

pluma_message_bus_is_registered

Check whether a message type method at object_path is registered on the bus.

since: 1.0

pluma_message_bus_lookup

Get the registered PlumaMessageType for method at object_path. The returned PlumaMessageType is owned by the bus and should not be unreffed.

since: 1.0

pluma_message_bus_register

Register a message on the bus. A message must be registered on the bus before it can be send. This function registers the type arguments for method at object_path. The arguments are specified with the variable arguments which should contain pairs of const gchar *key and GType terminated by NULL. The last num_optional arguments are registered as optional (and are thus not required when sending a message).

since: 1.0

pluma_message_bus_send

This provides a convenient way to quickly send a message method at object_path asynchronously over the bus. The variable argument list specifies key (string) value pairs used to construct the message arguments. To send a message synchronously use pluma_message_bus_send_sync().

since: 1.0

pluma_message_bus_send_message

This sends the provided message asynchronously over the bus. To send a message synchronously, use pluma_message_bus_send_message_sync(). The convenience function pluma_message_bus_send() can be used to easily send a message without constructing the message object explicitly first.

since: 1.0

pluma_message_bus_send_message_sync

This sends the provided message synchronously over the bus. To send a message asynchronously, use pluma_message_bus_send_message(). The convenience function pluma_message_bus_send_sync() can be used to easily send a message without constructing the message object explicitly first.

since: 1.0

pluma_message_bus_send_sync

This provides a convenient way to quickly send a message method at object_path synchronously over the bus. The variable argument list specifies key (string) value pairs used to construct the message arguments. To send a message asynchronously use pluma_message_bus_send().

since: 1.0

pluma_message_bus_unblock

Unblocks the callback specified by id.

since: 1.0

pluma_message_bus_unblock_by_func

Unblocks the callback that matches provided callback and userdata.

since: 1.0

pluma_message_bus_unregister

Unregisters a previously registered message type. This is especially useful for plugins which should unregister message types when they are deactivated.

since: 1.0

pluma_message_bus_unregister_all

Unregisters all message types for object_path. This is especially useful for plugins which should unregister message types when they are deactivated.

since: 1.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Signals

Pluma.MessageBus::dispatch

The “dispatch” signal is emitted when a message is to be dispatched. The message is dispatched in the default handler of this signal. Primary use of this signal is to customize the dispatch of a message (for instance to automatically dispatch all messages over DBus). 2

since: 1.0

Pluma.MessageBus::registered

The “registered” signal is emitted when a message has been registered on the bus.

since: 1.0

Pluma.MessageBus::unregistered

The “unregistered” signal is emitted when a message has been unregistered from the bus.

since: 1.0

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

unstable since: 2.0

Class structure

struct PlumaMessageBusClass {
  GObjectClass parent_class;
  void (* dispatch) (
    PlumaMessageBus* bus,
    PlumaMessage* message
  );
  void (* registered) (
    PlumaMessageBus* bus,
    PlumaMessageType* message_type
  );
  void (* unregistered) (
    PlumaMessageBus* bus,
    PlumaMessageType* message_type
  );
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.
dispatch: void (* dispatch) ( PlumaMessageBus* bus, PlumaMessage* message )
No description available.
registered: void (* registered) ( PlumaMessageBus* bus, PlumaMessageType* message_type )
No description available.
unregistered: void (* unregistered) ( PlumaMessageBus* bus, PlumaMessageType* message_type )
No description available.

Virtual methods

Pluma.MessageBusClass.dispatch
No description available.

since: 1.0

Pluma.MessageBusClass.registered
No description available.

since: 1.0

Pluma.MessageBusClass.unregistered
No description available.

since: 1.0