krähemann.com

AgsMessageQueue

AgsMessageQueue — message queue

Properties

gchar * recipient-namespace Read / Write
gchar * sender-namespace Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsMessageQueue

Includes

#include <ags/thread/ags_message_queue.h>

Description

The AgsMessageQueue acts as messages passing system.

Functions

AGS_MESSAGE_QUEUE_GET_OBJ_MUTEX()

#define AGS_MESSAGE_QUEUE_GET_OBJ_MUTEX(obj) (&(((AgsMessageQueue *) obj)->obj_mutex))

ags_message_queue_add_message_envelope ()

void
ags_message_queue_add_message_envelope
                               (AgsMessageQueue *message_queue,
                                GObject *message_envelope);

Add message to message_queue .

Parameters

message_queue

the AgsMessageQueue

 

message_envelope

the AgsMessageEnvelope

 

Since: 3.0.0


ags_message_queue_remove_message_envelope ()

void
ags_message_queue_remove_message_envelope
                               (AgsMessageQueue *message_queue,
                                GObject *message_envelope);

Remove message from message_queue .

Parameters

message_queue

the AgsMessageQueue

 

message_envelope

the AgsMessageEnvelope

 

Since: 3.0.0


ags_message_queue_find_sender ()

GList *
ags_message_queue_find_sender (AgsMessageQueue *message_queue,
                               GObject *sender);

Find sender in message_queue 's messages.

Parameters

message_queue

the AgsMessageQueue

 

sender

the sender as GObject

 

Returns

all matching AgsMessageEnvelope as GList.

[element-type Ags.MessageEnvelope][transfer full]

Since: 3.0.0


ags_message_queue_find_recipient ()

GList *
ags_message_queue_find_recipient (AgsMessageQueue *message_queue,
                                  GObject *recipient);

Find recipient in message_queue 's messages.

Parameters

message_queue

the AgsMessageQueue

 

recipient

the recipient as GObject

 

Returns

all matching AgsMessageEnvelope as GList.

[element-type Ags.MessageEnvelope][transfer full]

Since: 3.0.0


ags_message_queue_query_message ()

GList *
ags_message_queue_query_message (AgsMessageQueue *message_queue,
                                 gchar *xpath);

Query xpath in message_queue 's messages.

Parameters

message_queue

the AgsMessageQueue

 

xpath

the XPath as string

 

Returns

all matching AgsMessageEnvelope as GList.

[element-type Ags.MessageEnvelope][transfer full]

Since: 3.0.0


ags_message_queue_new ()

AgsMessageQueue *
ags_message_queue_new (gchar *sender_namespace);

Create a new instance of AgsMessageQueue.

Parameters

sender_namespace

the sender namespace

 

Returns

the new AgsMessageQueue

Since: 3.0.0


AGS_IS_MESSAGE_QUEUE()

#define AGS_IS_MESSAGE_QUEUE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_MESSAGE_QUEUE))

AGS_IS_MESSAGE_QUEUE_CLASS()

#define AGS_IS_MESSAGE_QUEUE_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_MESSAGE_QUEUE))

AGS_MESSAGE_QUEUE()

#define AGS_MESSAGE_QUEUE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_MESSAGE_QUEUE, AgsMessageQueue))

AGS_MESSAGE_QUEUE_CLASS()

#define AGS_MESSAGE_QUEUE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_MESSAGE_QUEUE, AgsMessageQueue))

AGS_MESSAGE_QUEUE_GET_CLASS()

#define AGS_MESSAGE_QUEUE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_MESSAGE_QUEUE, AgsMessageQueueClass))

ags_message_queue_get_type ()

GType
ags_message_queue_get_type ();

Types and Values

AGS_TYPE_MESSAGE_QUEUE

#define AGS_TYPE_MESSAGE_QUEUE                (ags_message_queue_get_type())

struct AgsMessageQueue

struct AgsMessageQueue;

struct AgsMessageQueueClass

struct AgsMessageQueueClass {
  GObjectClass gobject;

};

Property Details

The “recipient-namespace” property

  “recipient-namespace”      gchar *

The assigned namespace of recipient.

Owner: AgsMessageQueue

Flags: Read / Write

Default value: NULL

Since: 3.0.0


The “sender-namespace” property

  “sender-namespace”         gchar *

The assigned namespace of sender.

Owner: AgsMessageQueue

Flags: Read / Write

Default value: NULL

Since: 3.0.0