Ags.MessageDelivery¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_instance` ()
class	`new` ()
	`add_message_envelope` (sender_namespace, message_envelope)
	`add_message_queue` (message_queue)
	`find_recipient` (recipient_namespace, recipient)
	`find_recipient_namespace` (recipient_namespace)
	`find_sender` (recipient_namespace, sender)
	`find_sender_namespace` (sender_namespace)
	`get_message_queue` ()
	`query_message` (recipient_namespace, xpath)
	`remove_message_envelope` (sender_namespace, message_envelope)
	`remove_message_queue` (message_queue)
	`set_message_queue` (message_queue)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
gobject	`GObject.Object`	r
message_queue	[`object`]	r
obj_mutex	`GLib.RecMutex`	r

Class Details¶

class Ags.MessageDelivery(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.MessageDeliveryClass

classmethod get_instance()¶

Returns:: the Ags.MessageDelivery
Return type:: Ags.MessageDelivery

Get the Ags.MessageDelivery instance.

New in version 3.0.0.

classmethod new()¶

Returns:: the new Ags.MessageDelivery
Return type:: Ags.MessageDelivery

Create a new Ags.MessageDelivery.

New in version 3.0.0.

add_message_envelope(sender_namespace, message_envelope)¶

Parameters:

sender_namespace (str) – the sender namespace as string
message_envelope (GObject.Object) – the Ags.MessageEnvelope

Add message to an Ags.MessageQueue specified by sender_namespace.

New in version 3.0.0.

add_message_queue(message_queue)¶

Parameters:: message_queue (GObject.Object) – the Ags.MessageQueue

Add message_queue to self.

New in version 3.0.0.

find_recipient(recipient_namespace, recipient)¶

Parameters:

recipient_namespace (str) – the recipient namespace as string, maybe None
recipient (GObject.Object) – the recipient as GObject.Object

Returns:

all matching Ags.MessageEnvelope as GLib.List-struct

Return type:

[Ags.MessageEnvelope]

Find recipient for recipient_namespace matching Ags.MessageQueue. If recipient_namespace equals None match all available message queues.

New in version 3.0.0.

find_recipient_namespace(recipient_namespace)¶

Parameters:: recipient_namespace (str) – the recipient namespace as string to find
Returns:: the matching GLib.List-struct containing Ags.MessageQueue or None
Return type:: [Ags.MessageQueue]

Find recipient namespace of Ags.MessageQueue in self.

New in version 3.0.0.

find_sender(recipient_namespace, sender)¶

Parameters:

recipient_namespace (str) – the recipient namespace as string, maybe None
sender (GObject.Object) – the sender as GObject.Object

Returns:

all matching Ags.MessageEnvelope as GLib.List-struct

Return type:

[Ags.MessageEnvelope]

Find sender for recipient_namespace matching Ags.MessageQueue. If recipient_namespace equals None match all available message queues.

New in version 3.0.0.

find_sender_namespace(sender_namespace)¶

Parameters:: sender_namespace (str) – the sender namespace as string to find
Returns:: the matching GLib.List-struct containing Ags.MessageQueue or None
Return type:: [Ags.MessageQueue]

Find sender namespace of Ags.MessageQueue in self.

New in version 3.0.0.

get_message_queue()¶

Returns:: the GLib.List-struct containing Ags.MessageQueue
Return type:: [Ags.MessageQueue]

Get message queue of self.

New in version 3.6.16.

query_message(recipient_namespace, xpath)¶

Parameters:

recipient_namespace (str) – the recipient namespace as string, maybe None
xpath (str) – the xpath to query

Returns:

all matching Ags.MessageEnvelope as GLib.List-struct

Return type:

[Ags.MessageEnvelope]

Query xpath for recipient_namespace matching Ags.MessageQueue. If recipient_namespace equals None match all available message queues.

New in version 3.0.0.

remove_message_envelope(sender_namespace, message_envelope)¶

Parameters:

sender_namespace (str) – the sender namespace as string
message_envelope (GObject.Object) – the Ags.MessageEnvelope

Remove message from an Ags.MessageQueue specified by sender_namespace.

New in version 3.0.0.

remove_message_queue(message_queue)¶

Parameters:: message_queue (GObject.Object) – the Ags.MessageQueue

Remove message_queue to self.

New in version 3.0.0.

set_message_queue(message_queue)¶

Parameters:: message_queue ([Ags.MessageQueue]) – the GLib.List-struct containing Ags.MessageQueue

Set message_queue of self.

New in version 3.6.16.