XDispatch 0.6.1
Classes | Enumerations | Functions
xdispatch Namespace Reference

Classes

class  operation
 An operation is a functor used to define single portions of work to be dispatched to a single queue. More...
class  iteration_operation
class  ptr_operation
 Provides a template functor to wrap a function pointer to a memberfunction of an object as operation. More...
class  ptr_iteration_operation
 Provides a template functor to wrap a function pointer to a memberfunction of an object as iteration_operation. More...
class  block_operation
 A simple operation for wrapping the given block as an xdispatch::operation. More...
class  object
 The base class of all xdispatch classes. More...
class  group
 A group is a group of operations dispatched on queues. More...
class  queue
 Provides an interface for representing a dispatch queue and methods that can be called to modify or use the queue. More...
class  semaphore
 Wraps dispatch semaphores as provided by libDispatch. More...
struct  any
 Used for transferring data from a sourcetype to source::data without loosing typesafety. More...
class  sourcetype
 Declares an abstract source type. More...
class  source
 Provides a source implementation. More...
class  synclock
 Provides an easy locking mechanism used to ensure the threadsafety of a code area. More...
class  timer
 Provides a timer executing a block or an operation on a specific queue when a timeout occurs. More...

Enumerations

enum  queue_priority { HIGH = 2, DEFAULT = 1, LOW = 0 }
 Three priority classes used for the three standard global queues. More...

Functions

bool operator== (const dispatch_object_t &, const object &)
bool operator!= (const dispatch_object_t &, const object &)
queue main_queue ()
 Returns the main queue.
queue global_queue (queue_priority p=DEFAULT)
 Returns the global queue associated to the given Priority p.
queue current_queue ()
dispatch_time_t as_dispatch_time (struct tm *)
struct tm as_struct_tm (dispatch_time_t t)
dispatch_time_t as_delayed_time (uint64_t delay, dispatch_time_t base=DISPATCH_TIME_NOW)
void exec ()
 Enters the dispatching loop for the main thread.
std::ostream & operator<< (std::ostream &, const group *)
std::ostream & operator<< (std::ostream &, const group &)
std::ostream & operator<< (std::ostream &, const queue *)
std::ostream & operator<< (std::ostream &, const queue &)
std::ostream & operator<< (std::ostream &, const semaphore *)
std::ostream & operator<< (std::ostream &, const semaphore &)
bool operator== (const dispatch_semaphore_t &, const semaphore &)
bool operator!= (const dispatch_semaphore_t &, const semaphore &)
synclock get_lock_for_key (unsigned int key)
 Returns the synclock used to protect the area identified by the given key.

Enumeration Type Documentation

Three priority classes used for the three standard global queues.

Enumerator:
HIGH 
DEFAULT 
LOW 

Definition at line 201 of file base.h.


Function Documentation

dispatch_time_t xdispatch::as_delayed_time ( uint64_t  delay,
dispatch_time_t  base = DISPATCH_TIME_NOW 
)
Returns:
A dispatch_time_t representing the given delay
Parameters:
delayThe delay in nanoseconds
baseThe base to add the delay to, defaults to the current time
dispatch_time_t xdispatch::as_dispatch_time ( struct tm *  )
Returns:
The given QTime converted to a dispatch_time_t
struct tm xdispatch::as_struct_tm ( dispatch_time_t  t) [read]
Returns:
The given dispatch_time_t as time_t
queue xdispatch::current_queue ( )
Returns:
The queue the current operation is executed on.
void xdispatch::exec ( )

Enters the dispatching loop for the main thread.

Call this somewhere within the main thread to enable dispatching operations to the main queue. Will never return.

synclock xdispatch::get_lock_for_key ( unsigned int  key)

Returns the synclock used to protect the area identified by the given key.

See also:
synchronized
queue xdispatch::global_queue ( queue_priority  p = DEFAULT)

Returns the global queue associated to the given Priority p.

Runnables submitted to these global concurrent queues may be executed concurrently with respect to each other.

Remarks:
Never delete the returned queue!
Returns:
NULL if something went wrong
queue xdispatch::main_queue ( )

Returns the main queue.

This is the queue running within the main thread. Thus normally only items put on this queue can change the GUI.

Remarks:
Never delete the returned queue!
Returns:
NULL if something went wrong
bool xdispatch::operator!= ( const dispatch_semaphore_t ,
const semaphore &   
)
bool xdispatch::operator!= ( const dispatch_object_t ,
const object &   
)
std::ostream& xdispatch::operator<< ( std::ostream &  ,
const group &   
)
std::ostream& xdispatch::operator<< ( std::ostream &  ,
const semaphore &   
)
std::ostream& xdispatch::operator<< ( std::ostream &  ,
const semaphore *   
)
std::ostream& xdispatch::operator<< ( std::ostream &  ,
const queue *   
)
std::ostream& xdispatch::operator<< ( std::ostream &  ,
const queue &   
)
std::ostream& xdispatch::operator<< ( std::ostream &  ,
const group *   
)
bool xdispatch::operator== ( const dispatch_semaphore_t ,
const semaphore &   
)
bool xdispatch::operator== ( const dispatch_object_t ,
const object &   
)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Thu Apr 12 2012 09:50:43 for XDispatch by Doxygen 1.7.4
© 2010-2012 MLBA (about | privacy) All Rights reserved.