MidgardExecutable

MidgardExecutable

Synopsis

                    MidgardExecutable;
void                midgard_executable_execute          (MidgardExecutable *self,
                                                         GError **error);
void                midgard_executable_execute_async    (MidgardExecutable *self,
                                                         GError **error);
void                midgard_executable_execution_start  (MidgardExecutable *self);
void                midgard_executable_execution_end    (MidgardExecutable *self);

Object Hierarchy

  GInterface
   +----MidgardExecutable

Prerequisites

MidgardExecutable requires GObject.

Known Derived Interfaces

MidgardExecutable is required by MidgardContentManagerJob and MidgardJob.

Known Implementations

MidgardExecutable is implemented by MidgardQueryExecutor, MidgardQuerySelect, MidgardSqlContentManagerJob, MidgardSqlContentManagerJobCreate, MidgardSqlContentManagerJobDelete, MidgardSqlContentManagerJobLoad, MidgardSqlContentManagerJobPurge, MidgardSqlContentManagerJobUpdate and MidgardSqlQuerySelectData.

Signals

  "execution-end"                                  : No Hooks
  "execution-start"                                : No Hooks

Description

Details

MidgardExecutable

typedef struct _MidgardExecutable MidgardExecutable;


midgard_executable_execute ()

void                midgard_executable_execute          (MidgardExecutable *self,
                                                         GError **error);

Execute command or perform operation. Implementation shall check if given instance is valid. If it's not, shall invoke validation method, if given instance is MidgardValidable derived.

Before execution, implementation should emit 'execution-start' signal, and 'execution-end' when execution operation is completed.

self :

MidgardExecutable instance error (error-domains MIDGARD_EXECUTION_ERROR): location to store error

Since 10.05.5


midgard_executable_execute_async ()

void                midgard_executable_execute_async    (MidgardExecutable *self,
                                                         GError **error);

Execute asynchronous command or perform operation. Implementation shall check if given instance is valid. If it's not, shall invoke validation method, if given instance is MidgardValidable derived.

Implementation shall not emit any signal inside asynchronous method. Instead, signal emission should be added to GLib's default main loop(e.g. g_idle_add).

self :

MidgardExecutable instance error (error-domains MIDGARD_EXECUTION_ERROR): location to store error

Since 12.09


midgard_executable_execution_start ()

void                midgard_executable_execution_start  (MidgardExecutable *self);

Emits 'execution-start' signal on given executable.

self :

MidgardExecutable instance

Since 12.09


midgard_executable_execution_end ()

void                midgard_executable_execution_end    (MidgardExecutable *self);

Emits 'execution-end' signal on given executable.

self :

MidgardExecutable instance

Since 12.09

Signal Details

The "execution-end" signal

void                user_function                      (MidgardExecutable *executor,
                                                        gpointer           user_data)      : No Hooks

Gets emitted after executor's operation is executed

executor :

the MidgardExecutable

user_data :

user data set when the signal handler was connected.

The "execution-start" signal

void                user_function                      (MidgardExecutable *executor,
                                                        gpointer           user_data)      : No Hooks

Gets emitted before executor's operation is executed

executor :

the MidgardExecutable

user_data :

user data set when the signal handler was connected.