Threads

Threads

Jobs

JobMethod = CFUNCTYPE (None, c_void_p)
JobDataDelete = CFUNCTYPE (None, c_void_p)

class Job (Structure):
	_fields_ = [
		("method", JobMethod),
		("args", c_void_p),
	]

---

job_new () creates a new Job instance reference that should be deleted with job_delete ()

job_new () -> POINTER (Job)

Returns a new Job instance reference

---

job_delete () correctly disposes a Job instance reference

job_delete (
	c_void_p			# a Job instance reference
) -> None

---

job_create () creates a new Job instance reference with the ability to pass references to the work callback ands its data. It should be deleted with job_delete ()

job_create (
	JobMethod,			# the jobs's callback method
	c_void_p			# data to be passed to the callback method
) -> POINTER (Job)

Returns a new Job instance reference

---

job_get () gets a Job instance reference from the job queue's internal job pool that should be disposed using job_return ()

job_get (
	c_void_p			# reference to a JobQueue instance
) -> POINTER (Job)

Returns a Job instance reference

---

job_reset () resets the Job instance reference internal values

job_reset (
	c_void_p			# a Job instance reference
) -> None

---

job_return () pushes the Job instance reference into the job queue's internal job pool

job_return (
	c_void_p,			# reference to a JobQueue instance
	c_void_p			# a Job instance reference
) -> None

Job Hanlder

job_handler_new () creates a new JobHandler instance reference that should be deleted with job_handler_delete ()

job_handler_new () -> c_void_p

Returns a new JobHandler instance reference

---

job_handler_delete () correctly disposes a JobHandler instance reference

job_handler_delete (
	c_void_p			# reference to a JobHandler instance
) -> None

---

job_handler_create () creates a new JobHandler instance reference and initializes its internal data. It should be deleted with job_handler_delete ()

job_handler_create () -> c_void_p

Returns a new JobHandler instance reference

---

job_handler_get () gets a JobHandler instance reference from the job queue's handlers pool

job_handler_get (
	c_void_p			# reference to a JobQueue instance
) -> c_void_p

Returns a JobHandler instance reference

---

job_handler_reset () resets the JobHandler instance reference internal values

job_handler_reset (
	c_void_p			# reference to a JobHandler instance
) -> None

---

job_handler_signal () wakes up the waiting thread that called job_handler_wait ()

job_handler_signal (
	c_void_p			# reference to a JobHandler instance
) -> None

---

job_handler_return () pushes the JobHandler instance reference into the job queue's internal handlers pool

job_handler_return (
	c_void_p,			# reference to a JobQueue instance
	c_void_p			# reference to a JobHandler instance
) -> None

---

job_handler_wait () pushes a JobHandler instance with the data reference and the data delete method to the job queue to be handled by its dedicated thread. The calling thread will wait until job_handler_signal () is called from the handler method

job_handler_wait (
	c_void_p,			# reference to a JobQueue instance
	py_object,			# reference to an object that will be pased to the job queue's handler method
	JobDataDelete		# a method to dispose the data after it has been used
) -> None

Job Queue

JobQueueType

JOB_QUEUE_TYPE_NONE
JOB_QUEUE_TYPE_JOBS
JOB_QUEUE_TYPE_HANDLERS

JobQueueHandler = CFUNCTYPE (None, py_object)

---

job_queue_new () creates a new empty JobQueue instance

job_queue_new () -> c_void_p

Returns a new JobQueue instance reference

---

job_queue_delete () correctly disposes the JobQueue instance and all of its data

job_queue_delete (
	c_void_p			# reference to a JobQueue instance
) -> None

---

job_queue_create () creates a new JobQueue instance of the desired type

job_queue_create (
	JobQueueType		# the job queue's type
) -> c_void_p

Returns a new JobQueue instance reference

---

job_queue_set_handler () sets the job queue's callback method to be executed in a dedicated thread

job_queue_set_handler (
	c_void_p,			# reference to a JobQueue instance
	JobQueueHandler		# the callback to be executed in a dedicated thread
) -> None

---

job_queue_push () adds a new job or job handler to the queue

job_queue_push (
	c_void_p,			# reference to a JobQueue instance
	c_void_p			# reference to a Job or JobHandler instance
) -> c_int

Returns 0 on success, 1 on error

---

job_queue_push_job () creates & adds a new job to the queue

job_queue_push_job (
	c_void_p,			# reference to a JobQueue instance
	JobMethod,			# the job's callback method
	c_void_p			# reference to custom data
) -> c_int

Returns 0 on success, 1 on error

---

job_queue_push_handler () creates & adds a new handler to the queue

job_queue_push_handler (
	c_void_p,			# reference to a JobQueue instance
	c_void_p,			# reference to a Cerver instance
	c_void_p,			# reference to a Connection instance
	c_void_p,			# reference to custom data
	JobDataDelete		# the method to dispose the custom data
) -> c_int

Returns 0 on success, 1 on error

---

job_queue_pull () gets the job or job handler reference at the start of the queue

job_queue_pull (
	c_void_p			# reference to a JobQueue instance
) -> c_void_p

Returns a reference to a Job or JobHandler instance

---

job_queue_start () starts the job queue's dedicated thread

job_queue_start (
	c_void_p			# reference to a JobQueue instance
) -> c_uint

Returns 0 on success, 1 on error

---

job_queue_stop () stops the job queue's dedicated thread

job_queue_stop (
	c_void_p			# reference to a JobQueue instance
) -> c_uint

Returns 0 on success, 1 on error

---

job_queue_clear () clears the job queue and destroys all jobs

job_queue_clear (
	c_void_p			# reference to a JobQueue instance
) -> None