Background Operation

Data Structures
struct	JBackgroundOperation

Typedefs
typedef struct JBackgroundOperation	JBackgroundOperation
typedef gpointer(*	JBackgroundOperationFunc) (gpointer)

Functions
JBackgroundOperation *	j_background_operation_new (JBackgroundOperationFunc func, gpointer data)
JBackgroundOperation *	j_background_operation_ref (JBackgroundOperation *background_operation)
void	j_background_operation_unref (JBackgroundOperation *background_operation)
gpointer	j_background_operation_wait (JBackgroundOperation *background_operation)
void	j_background_operation_init (guint count)
void	j_background_operation_fini (void)
guint	j_background_operation_get_num_threads (void)

Detailed Description

Typedef Documentation

JBackgroundOperation

typedef struct JBackgroundOperation JBackgroundOperation

JBackgroundOperationFunc

typedef gpointer(* JBackgroundOperationFunc) (gpointer)

Function Documentation

j_background_operation_fini()

void j_background_operation_fini

(

void

)

Shuts down the background operation framework.

j_background_operation_fini();

j_background_operation_get_num_threads()

guint j_background_operation_get_num_threads

(

void

)

Gets the number of threads used.

j_background_operation_init()

void j_background_operation_init

(

guint

count

)

Initializes the background operation framework.

j_background_operation_init();

j_background_operation_new()

JBackgroundOperation * j_background_operation_new	(	JBackgroundOperationFunc	func,
		gpointer	data
	)

Creates a new background operation.

static
gpointer
background_func (gpointer data)
{
  return NULL;
}
 
JBackgroundOperation* background_operation;
 
background_operation = j_background_operation_new(background_func, NULL);

Parameters

func	A function to execute in the background.
data	User data given to func.

Returns

A new background operation. Should be freed with j_background_operation_unref().

j_background_operation_ref()

JBackgroundOperation * j_background_operation_ref

(

JBackgroundOperation *

background_operation

)

Increases a background operation's reference count.

JBackgroundOperation* background_operation;
 
j_background_operation_ref(background_operation);

Parameters

background_operation

A background operation.

Returns

background_operation.

j_background_operation_unref()

void j_background_operation_unref

(

JBackgroundOperation *

background_operation

)

Decreases a background operation's reference count. When the reference count reaches zero, frees the memory allocated for the background operation.

JBackgroundOperation* background_operation;
 
j_background_operation_unref(background_operation);

Parameters

background_operation

A background operation.

j_background_operation_wait()

gpointer j_background_operation_wait

(

JBackgroundOperation *

background_operation

)

Waits for a background operation to finish.

JBackgroundOperation* background_operation;
 
j_background_operation_wait(background_operation);

Parameters

background_operation

A background operation.

Returns

The return value of the function given to j_background_operation_new().