libXDispatch 0.6
Functions | Variables
include/libdispatch/object.h File Reference

Go to the source code of this file.

Functions

__DISPATCH_BEGIN_DECLS
DISPATCH_EXPORT
DISPATCH_NONNULL2
DISPATCH_NOTHROW 
DISPATCH_FORMAT (printf, 2, 3) void dispatch_debug(dispatch_object_t object
__DISPATCH_BEGIN_DECLS
DISPATCH_EXPORT
DISPATCH_NONNULL2
DISPATCH_NOTHROW const char
DISPATCH_EXPORT
DISPATCH_NONNULL2
DISPATCH_NOTHROW 
DISPATCH_FORMAT (printf, 2, 0) void dispatch_debugv(dispatch_object_t object
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_retain (dispatch_object_t object)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_release (dispatch_object_t object)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_PURE
DISPATCH_WARN_RESULT
DISPATCH_NOTHROW void * 
dispatch_get_context (dispatch_object_t object)
DISPATCH_EXPORT
DISPATCH_NOTHROW void 
dispatch_set_context (dispatch_object_t object, void *context)
DISPATCH_EXPORT
DISPATCH_NOTHROW void 
dispatch_set_finalizer_f (dispatch_object_t object, dispatch_function_t finalizer)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_suspend (dispatch_object_t object)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_resume (dispatch_object_t object)

Variables

__DISPATCH_BEGIN_DECLS
DISPATCH_EXPORT
DISPATCH_NONNULL2
DISPATCH_NOTHROW const char * 
message
__DISPATCH_BEGIN_DECLS
DISPATCH_EXPORT
DISPATCH_NONNULL2
DISPATCH_NOTHROW const char
DISPATCH_EXPORT
DISPATCH_NONNULL2
DISPATCH_NOTHROW const char
va_list 
ap

Function Documentation

__DISPATCH_BEGIN_DECLS DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW DISPATCH_FORMAT ( printf  ,
,
 
)

dispatch_debug

Programmatically log debug information about a dispatch object.

Parameters:
objectThe object to introspect.
messageThe message to log above and beyond the introspection.
__DISPATCH_BEGIN_DECLS DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW const char DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW DISPATCH_FORMAT ( printf  ,
,
 
)
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_PURE DISPATCH_WARN_RESULT DISPATCH_NOTHROW void* dispatch_get_context ( dispatch_object_t  object)

dispatch_get_context

Returns the application defined context of the object.

Parameters:
objectThe result of passing NULL in this parameter is undefined.
Returns:
The context of the object; may be NULL.
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_release ( dispatch_object_t  object)

dispatch_release

Decrement the reference count of a dispatch object.

A dispatch object is asynchronously deallocated once all references are released (i.e. the reference count becomes zero). The system does not guarantee that a given client is the last or only reference to a given object.

Parameters:
objectThe object to release. The result of passing NULL in this parameter is undefined.
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_resume ( dispatch_object_t  object)

dispatch_resume

Resumes the invocation of blocks on a dispatch object.

Parameters:
objectThe object to be resumed. The result of passing NULL in this parameter is undefined.
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_retain ( dispatch_object_t  object)

dispatch_retain

Increment the reference count of a dispatch object.

Calls to dispatch_retain() must be balanced with calls to dispatch_release().

Parameters:
objectThe object to retain. The result of passing NULL in this parameter is undefined.
DISPATCH_EXPORT DISPATCH_NOTHROW void dispatch_set_context ( dispatch_object_t  object,
void *  context 
)

dispatch_set_context

Associates an application defined context with the object.

Parameters:
objectThe result of passing NULL in this parameter is undefined.
contextThe new client defined context for the object. This may be NULL.
DISPATCH_EXPORT DISPATCH_NOTHROW void dispatch_set_finalizer_f ( dispatch_object_t  object,
dispatch_function_t  finalizer 
)

dispatch_set_finalizer_f

Set the finalizer function for a dispatch object.

Parameters:
Thedispatch object to modify. The result of passing NULL in this parameter is undefined.
Thefinalizer function pointer.

A dispatch object's finalizer will be invoked on the object's target queue after all references to the object have been released. This finalizer may be used by the application to release any resources associated with the object, such as freeing the object's context. The context parameter passed to the finalizer function is the current context of the dispatch object at the time the finalizer call is made.

DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_suspend ( dispatch_object_t  object)

dispatch_suspend

Suspends the invocation of blocks on a dispatch object.

A suspended object will not invoke any blocks associated with it. The suspension of an object will occur after any running block associated with the object completes.

Calls to dispatch_suspend() must be balanced with calls to dispatch_resume().

Parameters:
objectThe object to be suspended. The result of passing NULL in this parameter is undefined.

Variable Documentation

__DISPATCH_BEGIN_DECLS DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW const char DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW const char va_list ap
__DISPATCH_BEGIN_DECLS DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW const char DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW const char * message

Generated on Wed Feb 22 2012 19:57:00 for libXDispatch by Doxygen 1.7.4
Content © 2011-2012 MLBA (about | privacy) – Design © 2010-2012 Emzeat. All Rights reserved.