AgsTaskCompletion

AgsTaskCompletion — task completion

Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── AgsTaskCompletion

Implemented Interfaces

AgsTaskCompletion implements AgsConnectable.

Includes

#include <ags/thread/ags_task_completion.h>

Description

The AgsTaskCompletion should be used to complete tasks from caller thread.

Functions

ags_task_completion_complete ()

void
ags_task_completion_complete (AgsTaskCompletion *task_completion);

ags_task_completion_new ()

AgsTaskCompletion *
ags_task_completion_new (GObject *task,
                         gpointer data);

Create a new AgsTaskCompletion.

Parameters

task

the AgsTask

 

data

pointer to user data

 

Returns

the new AgsTaskCompletion

Since: 1.0.0


AGS_IS_TASK_COMPLETION()

#define AGS_IS_TASK_COMPLETION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_TASK_COMPLETION))

AGS_TASK_COMPLETION()

#define AGS_TASK_COMPLETION(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_TASK_COMPLETION, AgsTaskCompletion))

AGS_TASK_COMPLETION_CLASS()

#define AGS_TASK_COMPLETION_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_TASK_COMPLETION, AgsTaskCompletionClass))

AGS_TASK_COMPLETION_GET_CLASS()

#define AGS_TASK_COMPLETION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_TASK_COMPLETION, AgsTaskCompletionClass))

ags_task_completion_get_type ()

GType
ags_task_completion_get_type ();

Types and Values

enum AgsTaskCompletionFlags

Enum values to control the behavior or indicate internal state of AgsTaskCompletion by enable/disable as flags.

Members

AGS_TASK_COMPLETION_QUEUED

the assigned task has been queued

 

AGS_TASK_COMPLETION_BUSY

the assigned task is busy

 

AGS_TASK_COMPLETION_READY

the assigned task is ready

 

AGS_TASK_COMPLETION_COMPLETED

the assigned task has been completed

 

AGS_TYPE_TASK_COMPLETION

#define AGS_TYPE_TASK_COMPLETION                (ags_task_completion_get_type())

struct AgsTaskCompletion

struct AgsTaskCompletion;

struct AgsTaskCompletionClass

struct AgsTaskCompletionClass {
  GObjectClass gobject;

  void (*complete)(AgsTaskCompletion *task_completion);
};

Signal Details

The “complete” signal

void
user_function (AgsTaskCompletion *task_completion,
               gpointer           user_data)

The ::complete signal is emited as a task was finished

Parameters

task_completion

the object to complete.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last