Ags.MessageQueue¶

Subclasses:: None

Methods¶

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

class	`new` (sender_namespace)
	`add_message_envelope` (message_envelope)
	`find_recipient` (recipient)
	`find_sender` (sender)
	`get_message_envelope` ()
	`get_recipient_namespace` ()
	`get_sender_namespace` ()
	`query_message` (xpath)
	`remove_message_envelope` (message_envelope)
	`set_message_envelope` (message_envelope)
	`set_recipient_namespace` (recipient_namespace)
	`set_sender_namespace` (sender_namespace)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`recipient-namespace`	`str`	r/w	The recipient’s namespace this message queue is assigned to
`sender-namespace`	`str`	r/w	The sender’s namespace this message queue is assigned to

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
gobject	`GObject.Object`	r
message_envelope	[`object`]	r
obj_mutex	`GLib.RecMutex`	r
recipient_namespace	`str`	r
sender_namespace	`str`	r

Class Details¶

class Ags.MessageQueue(**kwargs)¶

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

classmethod new(sender_namespace)¶

Parameters:: sender_namespace (str) – the sender namespace
Returns:: the new Ags.MessageQueue
Return type:: Ags.MessageQueue

Create a new instance of Ags.MessageQueue.

New in version 3.0.0.

add_message_envelope(message_envelope)¶

Parameters:: message_envelope (GObject.Object) – the Ags.MessageEnvelope

Add message to self.

New in version 3.0.0.

find_recipient(recipient)¶

Parameters:: recipient (GObject.Object) – the recipient as GObject.Object
Returns:: all matching Ags.MessageEnvelope as GLib.List-struct
Return type:: [Ags.MessageEnvelope]

Find recipient in self's messages.

New in version 3.0.0.

find_sender(sender)¶

Parameters:: sender (GObject.Object) – the sender as GObject.Object
Returns:: all matching Ags.MessageEnvelope as GLib.List-struct
Return type:: [Ags.MessageEnvelope]

Find sender in self's messages.

New in version 3.0.0.

get_message_envelope()¶

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

Get message envelope of self.

New in version 3.6.16.

get_recipient_namespace()¶

Returns:: the recipient namespace
Return type:: str

Get recipient namespace of self.

New in version 3.6.16.

get_sender_namespace()¶

Returns:: the sender namespace
Return type:: str

Get sender namespace of self.

New in version 3.6.16.

query_message(xpath)¶

Parameters:: xpath (str) – the XPath as string
Returns:: all matching Ags.MessageEnvelope as GLib.List-struct
Return type:: [Ags.MessageEnvelope]

Query xpath in self's messages.

New in version 3.0.0.

remove_message_envelope(message_envelope)¶

Parameters:: message_envelope (GObject.Object) – the Ags.MessageEnvelope

Remove message from self.

New in version 3.0.0.

set_message_envelope(message_envelope)¶

Parameters:: message_envelope ([Ags.MessageEnvelope]) – the GLib.List-struct containing Ags.MessageEnvelope

Set message_envelope of self.

New in version 3.6.16.

set_recipient_namespace(recipient_namespace)¶

Parameters:: recipient_namespace (str) – the recipient namespace

Set recipient_namespace of self.

New in version 3.6.16.

set_sender_namespace(sender_namespace)¶

Parameters:: sender_namespace (str) – the sender namespace

Set sender_namespace of self.

New in version 3.6.16.

Property Details¶

Ags.MessageQueue.props.recipient_namespace¶

Name:: recipient-namespace
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned namespace of recipient.

New in version 3.0.0.

Ags.MessageQueue.props.sender_namespace¶

Name:: sender-namespace
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned namespace of sender.

New in version 3.0.0.