CodeSlayerProcess

CodeSlayerProcess — Contains the documents.

Synopsis

#include <codeslayer/codeslayer-process.h>

struct              CodeSlayerProcess;
void                (*StopProcessFunc)                  (gpointer data);
CodeSlayerProcess * codeslayer_process_new              (gint id);
const gint          codeslayer_process_get_id           (CodeSlayerProcess *process);
const gchar *       codeslayer_process_get_name         (CodeSlayerProcess *process);
void                codeslayer_process_set_name         (CodeSlayerProcess *process,
                                                         const gchar *name);
StopProcessFunc     codeslayer_process_get_func         (CodeSlayerProcess *process);
void                codeslayer_process_set_func         (CodeSlayerProcess *process,
                                                         StopProcessFunc func);
gpointer            codeslayer_process_get_data         (CodeSlayerProcess *process);
void                codeslayer_process_set_data         (CodeSlayerProcess *process,
                                                         gpointer data);
void                codeslayer_process_stop             (CodeSlayerProcess *process);

Object Hierarchy

  GObject
   +----CodeSlayerProcess

Properties

  "data"                     gpointer              : Read / Write
  "func"                     gpointer              : Read / Write
  "name"                     gchar*                : Read / Write

Signals

  "stopped"                                        : No Hooks

Description

Details

struct CodeSlayerProcess

struct CodeSlayerProcess;

StopProcessFunc ()

void                (*StopProcessFunc)                  (gpointer data);

codeslayer_process_new ()

CodeSlayerProcess * codeslayer_process_new              (gint id);

Creates a new CodeSlayerProcess.

id :

the process identifier.

Returns :

a new CodeSlayerProcess.

codeslayer_process_get_id ()

const gint          codeslayer_process_get_id           (CodeSlayerProcess *process);

process :

a CodeSlayerProcess.

Returns :

the identifier for the process.

codeslayer_process_get_name ()

const gchar *       codeslayer_process_get_name         (CodeSlayerProcess *process);

process :

a CodeSlayerProcess.

Returns :

the text to display for the process.

codeslayer_process_set_name ()

void                codeslayer_process_set_name         (CodeSlayerProcess *process,
                                                         const gchar *name);

process :

a CodeSlayerProcess.

name :

the text to display for the process.

codeslayer_process_get_func ()

StopProcessFunc     codeslayer_process_get_func         (CodeSlayerProcess *process);

process :

a CodeSlayerProcess.

Returns :

the callback function for when the process is stopped

codeslayer_process_set_func ()

void                codeslayer_process_set_func         (CodeSlayerProcess *process,
                                                         StopProcessFunc func);

process :

a CodeSlayerProcess.

func :

the callback function for when the process is stopped

codeslayer_process_get_data ()

gpointer            codeslayer_process_get_data         (CodeSlayerProcess *process);

process :

a CodeSlayerProcess.

Returns :

the data for the stopped callback function

codeslayer_process_set_data ()

void                codeslayer_process_set_data         (CodeSlayerProcess *process,
                                                         gpointer data);

process :

a CodeSlayerProcess.

data :

the data for the stopped callback function

codeslayer_process_stop ()

void                codeslayer_process_stop             (CodeSlayerProcess *process);

Stop the running thread

process :

a CodeSlayerProcess.

Property Details

The "data" property

  "data"                     gpointer              : Read / Write

The thread data for the process.


The "func" property

  "func"                     gpointer              : Read / Write

The callback function for the process.


The "name" property

  "name"                     gchar*                : Read / Write

The displayed name for the process.

Default value: ""

Signal Details

The "stopped" signal

void                user_function                      (CodeSlayerProcess *codeslayerprocess,
                                                        gpointer           arg1,
                                                        gpointer           user_data)              : No Hooks

Note: for internal use only.

The ::stopped signal is invoked when a thread is finished

codeslayerprocess :

the process that received the signal

user_data :

user data set when the signal handler was connected.