xdispatch::queue Class Reference

Provides an interface for representing a dispatch queue and methods that can be called to modify or use the queue. More...

Inheritance diagram for xdispatch::queue:

List of all members.

Public Member Functions
	queue (dispatch_queue_t)
	Creates a new queue using the given dispatch_queue_t object.
	queue (const char *label)
	Creates a new serial queue featuring the given label.
	queue (const std::string &)
	queue (const queue &)
	~queue ()
virtual void	async (operation *)
	Will dispatch the given operation for async execution on the queue and return immediately.
virtual void	async (dispatch_block_t)
	Same as async(operation*).
virtual void	apply (iteration_operation *, size_t times)
	Applies the given iteration_operation for async execution in this queue and returns immediately.
virtual void	apply (dispatch_iteration_block_t, size_t times)
	Same as apply(iteration_operation*, size_t times).
virtual void	after (operation *, struct tm *time)
	Applies the given operation for async execution in this queue after the given time and returns immediately.
virtual void	after (operation *, dispatch_time_t time)
virtual void	after (dispatch_block_t, struct tm *time)
	Same as dispatch_after(operation*, time_t).
virtual void	after (dispatch_block_t, dispatch_time_t time)
virtual void	sync (operation *)
	Applies the given operation for execution in this queue and blocks until the operation was executed.
virtual void	sync (dispatch_block_t)
	Same as dispatch_sync(operation*).
virtual void	finalizer (operation *, const queue &=global_queue())
	Sets the given operation as finalizer for this queue.
virtual void	finalizer (dispatch_block_t, const queue &=global_queue())
	Same as set_finalizer(operation*, queue*).
virtual const std::string	label () const
virtual void	suspend ()
	Suspends the invocation of work items on this queue.
virtual void	resume ()
	Resumes the invocation of work items on this queue.
virtual dispatch_object_t	native () const
virtual void	target_queue (const queue &)
	Sets the target queue of this queue, i.e.
queue &	operator= (const queue &)

---

Detailed Description

Provides an interface for representing a dispatch queue and methods that can be called to modify or use the queue.

Read Apple's documentation of libDispatch to understand the concept of tasks and queues.

See also:

xdispatch::dispatch for creation of queues

---

Constructor & Destructor Documentation

xdispatch::queue::queue

(

dispatch_queue_t

)

Creates a new queue using the given dispatch_queue_t object.

xdispatch::queue::queue

(

const char *

label

)

Creates a new serial queue featuring the given label.

xdispatch::queue::queue

(

const std::string &

)

xdispatch::queue::queue

(

const queue &

)

xdispatch::queue::~queue

(

)

---

Member Function Documentation

virtual void xdispatch::queue::after	(	operation *	,
		struct tm *	time
	)		[virtual]

Applies the given operation for async execution in this queue after the given time and returns immediately.

The queue will take possession of the operation and handle the deletion. To change this behaviour, set the auto_delete flag of the operation.

See also:

operation::auto_delete();

Parameters:

time	The time to wait until the operation is applied to the queue.

virtual void xdispatch::queue::after	(	dispatch_block_t	,
		dispatch_time_t	time
	)		[virtual]

virtual void xdispatch::queue::after	(	operation *	,
		dispatch_time_t	time
	)		[virtual]

virtual void xdispatch::queue::after	(	dispatch_block_t	,
		struct tm *	time
	)		[virtual]

Same as dispatch_after(operation*, time_t).

Will wrap the given block in an operation and put it on the queue.

virtual void xdispatch::queue::apply	(	iteration_operation *	,
		size_t	times
	)		[virtual]

Applies the given iteration_operation for async execution in this queue and returns immediately.

The operation will be deleted as soon as it was executed the requested number of times. To change this behaviour, set the auto_delete flag of the operation.

See also:

operation::auto_delete()

Parameters:

times

The number of times the operation will be executed

virtual void xdispatch::queue::apply	(	dispatch_iteration_block_t	,
		size_t	times
	)		[virtual]

Same as apply(iteration_operation*, size_t times).

Will wrap the given block in an operation and put it on the queue.

See also:

apply(iteration_operation*, size_t times)

virtual void xdispatch::queue::async

(

dispatch_block_t

)

[virtual]

Same as async(operation*).

Will put the given block on the queue.

virtual void xdispatch::queue::async

(

operation *

)

[virtual]

Will dispatch the given operation for async execution on the queue and return immediately.

The operation will be deleted as soon as it was executed. To change this behaviour, set the auto_delete flag of the operation.

See also:

operation::auto_delete()

virtual void xdispatch::queue::finalizer	(	operation *	,
		const queue &	= global_queue()
	)		[virtual]

Sets the given operation as finalizer for this queue.

A finalizer is called before destroying a queue, i.e. if all queue objects representing the queue were deleted and all pending work on a queue was dispatched. The queue will take possession of the operation and handle the deletion. To change this behaviour, set the auto_delete flag of the operation.

See also:

operation::auto_delete();

When not passing a queue, the finalizer operation will be executed on the queue itself.

virtual void xdispatch::queue::finalizer	(	dispatch_block_t	,
		const queue &	= global_queue()
	)		[virtual]

Same as set_finalizer(operation*, queue*).

Will wrap the given block in an operation and store it as finalizer.

virtual const std::string xdispatch::queue::label

(

)

const [virtual]

Returns:

The label of the queue that was used while creating it

virtual dispatch_object_t xdispatch::queue::native

(

)

const [virtual]

Returns:

The dispatch_queue_t object associated with this C++ object. Use this, if you need to use the plain C Interface of libdispatch.

Implements xdispatch::object.

queue& xdispatch::queue::operator=

(

const queue &

)

virtual void xdispatch::queue::resume

(

)

[virtual]

Resumes the invocation of work items on this queue.

Calls to suspend() must be balanced with calls to resume().

Implements xdispatch::object.

Reimplemented in QDispatchQueue.

virtual void xdispatch::queue::suspend

(

)

[virtual]

Suspends the invocation of work items on this queue.

A suspended queue will not invoke any blocks associated with it. The suspension of a queue will occur after any running work item associated with the queue completes.

Calls to suspend() must be balanced with calls to resume().

Implements xdispatch::object.

Reimplemented in QDispatchQueue.

virtual void xdispatch::queue::sync

(

dispatch_block_t

)

[virtual]

Same as dispatch_sync(operation*).

Will wrap the given block in an operation and put it on the queue.

virtual void xdispatch::queue::sync

(

operation *

)

[virtual]

Applies the given operation for execution in this queue and blocks until the operation was executed.

The queue will take possession of the operation and handle the deletion. To change this behaviour, set the auto_delete flag of the operation.

See also:

operation::auto_delete();

virtual void xdispatch::queue::target_queue

(

const queue &

)

[virtual]

Sets the target queue of this queue, i.e.

the queue all items of this queue will be dispatched on in turn.

Remarks:

This has no effect on the global queues and the main queue.

---

The documentation for this class was generated from the following file:

• include/xdispatch/queue.h