Asynchron job ticket. More...

#include <oyranos_threads.h>

Inheritance diagram for oyJob_s:

Collaboration diagram for oyJob_s:

Public Member Functions
void	oyJobHandlingSet (oyJob_Add_f jadd, oyJob_Get_f jget, oyMsg_Add_f madd, oyJobResult_f result, const char *nick)
	Initialise the oyJob_s APIs.
	oyJob_New
	Allocate a new oyJob_s object.
	oyJob_Release
	Deallocate a oyJob_s object.
Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump.
	oyStruct_RegisterStaticMessageFunc
	register a function for verbosity
	oyStruct_GetInfo
	get a additional string from a object
const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string.

Data Fields
oyOBJECT_e	type_
	oyOBJECT_JOB_S
oyStruct_Copy_f	copy_not
	keep to zero; as it is dangerous in a threaded context
oyStruct_Release_f	release
	Release function; optional.
oyObject_s	oy_
	Oyranos internal object; not needed, keep to zero.
oyStruct_s *	context
	the workload
int(*	work )(oyJob_s *job)
	the working thread callback
int	status_work_return
	return value of the work() function
int(*	finish )(oyJob_s *job)
	the observating thread callback
oyJobCallback_f	cb_progress
	the progress callback, called by observating thread
oyStruct_s *	cb_progress_context
	the progress callback context
int	id_
int	thread_id_
int	status_done_
oyJob_Add_f	oyJob_Add = oyJob_AddInit
	Add one unique oyJob_s to the job qeue.
oyJob_Get_f	oyJob_Get = oyJob_GetInit
	Get one unique oyJob_s from the job qeue.
oyMsg_Add_f	oyMsg_Add = oyMsg_AddInit
	Add one unique message from the message qeue.
oyJobResult_f	oyJobResult = oyJobResultInit
	Poll for new Jobs.
Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object.
oyStruct_Copy_f	copy
	Copy function.
oyStruct_Release_f	release
	Release function.
oyObject_s	oy_
	Oyranos internal object.

Detailed Description

Asynchron job ticket.

A generic job is added to the single job queue with oyJob_Add(). The job queue is worked on by an internal maintained thead.

Version: Oyranos: 0.9.6

Date: 2016/05/01

Since: 2014/01/27 (Oyranos: 0.9.5)

Examples: image_display.cpp.

Field Documentation

◆ cb_progress

oyJobCallback_f oyJob_s::cb_progress

the progress callback, called by observating thread

Examples: image_display.cpp.

Referenced by oyJob_New().

◆ cb_progress_context

oyStruct_s* oyJob_s::cb_progress_context

the progress callback context

Referenced by oyJob_Release().

◆ context

oyStruct_s* oyJob_s::context

the workload

Examples: image_display.cpp.

Referenced by oyJob_Release().

◆ copy_not

oyStruct_Copy_f oyJob_s::copy_not

keep to zero; as it is dangerous in a threaded context

◆ finish

int(* oyJob_s::finish) (oyJob_s *job)

the observating thread callback

Examples: image_display.cpp.

◆ id_

int oyJob_s::id_

Oyranos provided work ID, keep read only

◆ oy_

oyObject_s oyJob_s::oy_

Oyranos internal object; not needed, keep to zero.

◆ release

oyStruct_Release_f oyJob_s::release

Release function; optional.

◆ status_done_

int oyJob_s::status_done_

Oyranos internal variable

◆ status_work_return

int oyJob_s::status_work_return

return value of the work() function

◆ thread_id_

int oyJob_s::thread_id_

Oyranos provided ID; keep read only

◆ type_

oyOBJECT_e oyJob_s::type_

oyOBJECT_JOB_S

Referenced by oyJob_New(), and oyJob_Release().

◆ work

int(* oyJob_s::work) (oyJob_s *job)

the working thread callback

Examples: image_display.cpp.

Public Member Functions

Data Fields