#include <dispatch/object.h> also included by <dispatch/dispatch.h>
Dispatch

dispatch/object.h

for HeaderDoc
includes: sys/qos.h
18 macros · 15 functions · 3 typedefs · 1 union

uniondispatch_object_t

size 8, align 8
struct _os_object_s *_os_obj
struct dispatch_object_s *_do
struct dispatch_queue_s *_dq
struct dispatch_queue_attr_s *_dqa
struct dispatch_group_s *_dg
struct dispatch_source_s *_ds
struct dispatch_channel_s *_dch
struct dispatch_mach_s *_dm
struct dispatch_mach_msg_s *_dmsg
struct dispatch_semaphore_s *_dsema
struct dispatch_data_s *_ddata
struct dispatch_io_s *_dchannel

typedefdispatch_object_t

typedef union dispatch_object_t dispatch_object_t;

macroDISPATCH_DECL

#define DISPATCH_DECL(name) typedef struct name##_s *name##_t

macroDISPATCH_DECL_SUBCLASS

#define DISPATCH_DECL_SUBCLASS(name, base) typedef base##_t name##_t

macroDISPATCH_DECL_FACTORY_CLASS_SWIFT

#define DISPATCH_DECL_FACTORY_CLASS_SWIFT(name, swift_name) DISPATCH_DECL_SWIFT(name, swift_name)

macroDISPATCH_DECL_SWIFT

#define DISPATCH_DECL_SWIFT(name, swift_name) DISPATCH_DECL(name)

macroDISPATCH_DECL_SUBCLASS_SWIFT

#define DISPATCH_DECL_SUBCLASS_SWIFT(name, base, swift_name) DISPATCH_DECL_SUBCLASS(name, base)

macroDISPATCH_DECL_SERIAL_EXECUTOR_SWIFT

#define DISPATCH_DECL_SERIAL_EXECUTOR_SWIFT(name, swift_name) DISPATCH_DECL_SUBCLASS_SWIFT(name, dispatch_queue, swift_name)

macroDISPATCH_GLOBAL_OBJECT

#define DISPATCH_GLOBAL_OBJECT(type, object) ((type)&(object))

macroDISPATCH_RETURNS_RETAINED

#define DISPATCH_RETURNS_RETAINED

macroDISPATCH_SOURCE_DECL

#define DISPATCH_SOURCE_DECL(name) DISPATCH_DECL(name);

macroDISPATCH_SOURCE_DECL_SWIFT

#define DISPATCH_SOURCE_DECL_SWIFT(name, swift_name, protocol_name) DISPATCH_SOURCE_DECL(name)

macroDISPATCH_DATA_DECL

#define DISPATCH_DATA_DECL(name) DISPATCH_DECL(name)

macroDISPATCH_DATA_DECL_SWIFT

#define DISPATCH_DATA_DECL_SWIFT(name, swift_name) DISPATCH_DATA_DECL(name)

macroDISPATCH_SOURCE_TYPE_DECL

#define DISPATCH_SOURCE_TYPE_DECL(name) DISPATCH_EXPORT const struct dispatch_source_type_s
		_dispatch_source_type_##name

macroDISPATCH_SOURCE_TYPE_DECL_SWIFT

#define DISPATCH_SOURCE_TYPE_DECL_SWIFT(name, swift_name) DISPATCH_SOURCE_TYPE_DECL(name)

typedefdispatch_block_t

typedef void (^dispatch_block_t)(void)

typedefdispatch_qos_class_t

typedef qos_class_t dispatch_qos_class_t

functiondispatch_retain

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW DISPATCH_SWIFT_UNAVAILABLE("Can't be used with ARC") void dispatch_retain(
	dispatch_object_t object
)
@function dispatch_retain @abstract Increment the reference count of a dispatch object. @discussion Calls to dispatch_retain() must be balanced with calls to dispatch_release(). @param object The object to retain. The result of passing NULL in this parameter is undefined.

functiondispatch_release

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW DISPATCH_SWIFT_UNAVAILABLE("Can't be used with ARC") void dispatch_release(
	dispatch_object_t object
)
@function dispatch_release @abstract Decrement the reference count of a dispatch object. @discussion 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. @param object The object to release. The result of passing NULL in this parameter is undefined.

functiondispatch_get_context

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_PURE DISPATCH_WARN_RESULT DISPATCH_NOTHROW DISPATCH_SWIFT_UNAVAILABLE("Unavailable in Swift") void *_Nullable dispatch_get_context(
	dispatch_object_t object
)
@function dispatch_get_context @abstract Returns the application defined context of the object. @param object The result of passing NULL in this parameter is undefined. @result The context of the object; may be NULL.

functiondispatch_set_context

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NOTHROW DISPATCH_SWIFT_UNAVAILABLE("Unavailable in Swift") void dispatch_set_context(
	dispatch_object_t object,
	void *_Nullable context
)
@function dispatch_set_context @abstract Associates an application defined context with the object. @param object The result of passing NULL in this parameter is undefined. @param context The new client defined context for the object. This may be NULL.

functiondispatch_set_finalizer_f

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NOTHROW DISPATCH_SWIFT_UNAVAILABLE("Unavailable in Swift") void dispatch_set_finalizer_f(
	dispatch_object_t object,
	dispatch_function_t _Nullable finalizer
)
@function dispatch_set_finalizer_f @abstract Set the finalizer function for a dispatch object. @param object The dispatch object to modify. The result of passing NULL in this parameter is undefined. @param finalizer The finalizer function pointer. @discussion 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.

functiondispatch_activate

API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0)) DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW DISPATCH_SWIFT_NAME(DispatchObject.activate(self:)) void dispatch_activate(
	dispatch_object_t object
)
@function dispatch_activate @abstract Activates the specified dispatch object. @discussion Dispatch objects such as queues and sources may be created in an inactive state. Objects in this state have to be activated before any blocks associated with them will be invoked. The target queue of inactive objects can be changed using dispatch_set_target_queue(). Change of target queue is no longer permitted once an initially inactive object has been activated. Calling dispatch_activate() on an active object has no effect. Releasing the last reference count on an inactive object is undefined. @param object The object to be activated. The result of passing NULL in this parameter is undefined.

functiondispatch_suspend

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW DISPATCH_SWIFT_NAME(DispatchObject.suspend(self:)) void dispatch_suspend(
	dispatch_object_t object
)
@function dispatch_suspend @abstract Suspends the invocation of blocks on a dispatch object. @discussion 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(). @param object The object to be suspended. The result of passing NULL in this parameter is undefined.

functiondispatch_resume

API_AVAILABLE(macos(10.6), ios(4.0)) DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW DISPATCH_SWIFT_NAME(DispatchObject.resume(self:)) void dispatch_resume(
	dispatch_object_t object
)
@function dispatch_resume @abstract Resumes the invocation of blocks on a dispatch object. @discussion Dispatch objects can be suspended with dispatch_suspend(), which increments an internal suspension count. dispatch_resume() is the inverse operation, and consumes suspension counts. When the last suspension count is consumed, blocks associated with the object will be invoked again. For backward compatibility reasons, dispatch_resume() on an inactive and not otherwise suspended dispatch source object has the same effect as calling dispatch_activate(). For new code, using dispatch_activate() is preferred. If the specified object has zero suspension count and is not an inactive source, this function will result in an assertion and the process being terminated. @param object The object to be resumed. The result of passing NULL in this parameter is undefined.

functiondispatch_set_qos_class_floor

API_AVAILABLE(macos(10.14), ios(12.0), tvos(12.0), watchos(5.0)) DISPATCH_EXPORT DISPATCH_NOTHROW DISPATCH_SWIFT_UNAVAILABLE("Unavailable in Swift") void dispatch_set_qos_class_floor(
	dispatch_object_t object,
	dispatch_qos_class_t qos_class,
	int relative_priority
)
@function dispatch_set_qos_class_floor @abstract Sets the QOS class floor on a dispatch queue, source or workloop. @discussion The QOS class of workitems submitted to this object asynchronously will be elevated to at least the specified QOS class floor. The QOS of the workitem will be used if higher than the floor even when the workitem has been created without "ENFORCE" semantics. Setting the QOS class floor is equivalent to the QOS effects of configuring a queue whose target queue has a QoS class set to the same value. @param object A dispatch queue, workloop, or source to configure. The object must be inactive. Passing another object type or an object that has been activated is undefined and will cause the process to be terminated. @param qos_class A QOS class value: - QOS_CLASS_USER_INTERACTIVE - QOS_CLASS_USER_INITIATED - QOS_CLASS_DEFAULT - QOS_CLASS_UTILITY - QOS_CLASS_BACKGROUND Passing any other value is undefined. @param relative_priority A relative priority within the QOS class. This value is a negative offset from the maximum supported scheduler priority for the given class. Passing a value greater than zero or less than QOS_MIN_RELATIVE_PRIORITY is undefined.

functiondispatch_wait

DISPATCH_UNAVAILABLE DISPATCH_EXPORT DISPATCH_NONNULL1 DISPATCH_NOTHROW intptr_t dispatch_wait(
	void *object,
	dispatch_time_t timeout
)
not_available
@function dispatch_wait @abstract Wait synchronously for an object or until the specified timeout has elapsed. @discussion Type-generic macro that maps to dispatch_block_wait, dispatch_group_wait or dispatch_semaphore_wait, depending on the type of the first argument. See documentation for these functions for more details. This function is unavailable for any other object type. @param object The object to wait on. The result of passing NULL in this parameter is undefined. @param timeout When to timeout (see dispatch_time). As a convenience, there are the DISPATCH_TIME_NOW and DISPATCH_TIME_FOREVER constants. @result Returns zero on success or non-zero on error (i.e. timed out).

macrodispatch_wait

#define dispatch_wait(object, timeout) _Generic((object),
			dispatch_block_t:dispatch_block_wait,
			dispatch_group_t:dispatch_group_wait,
			dispatch_semaphore_t:dispatch_semaphore_wait
		)((object),(timeout))

functiondispatch_notify

DISPATCH_UNAVAILABLE DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_notify(
	void *object,
	dispatch_object_t queue,
	dispatch_block_t notification_block
)
not_available
@function dispatch_notify @abstract Schedule a notification block to be submitted to a queue when the execution of a specified object has completed. @discussion Type-generic macro that maps to dispatch_block_notify or dispatch_group_notify, depending on the type of the first argument. See documentation for these functions for more details. This function is unavailable for any other object type. @param object The object to observe. The result of passing NULL in this parameter is undefined. @param queue The queue to which the supplied notification block will be submitted when the observed object completes. @param notification_block The block to submit when the observed object completes.

macrodispatch_notify

#define dispatch_notify(object, queue, notification_block) _Generic((object),
			dispatch_block_t:dispatch_block_notify,
			dispatch_group_t:dispatch_group_notify
		)((object),(queue), (notification_block))

functiondispatch_cancel

DISPATCH_UNAVAILABLE DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_cancel(
	void *object
)
not_available
@function dispatch_cancel @abstract Cancel the specified object. @discussion Type-generic macro that maps to dispatch_block_cancel or dispatch_source_cancel, depending on the type of the first argument. See documentation for these functions for more details. This function is unavailable for any other object type. @param object The object to cancel. The result of passing NULL in this parameter is undefined.

macrodispatch_cancel

#define dispatch_cancel(object) _Generic((object),
			dispatch_block_t:dispatch_block_cancel,
			dispatch_source_t:dispatch_source_cancel
		)((object))

functiondispatch_testcancel

DISPATCH_UNAVAILABLE DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_WARN_RESULT DISPATCH_PURE DISPATCH_NOTHROW intptr_t dispatch_testcancel(
	void *object
)
not_available
@function dispatch_testcancel @abstract Test whether the specified object has been canceled @discussion Type-generic macro that maps to dispatch_block_testcancel or dispatch_source_testcancel, depending on the type of the first argument. See documentation for these functions for more details. This function is unavailable for any other object type. @param object The object to test. The result of passing NULL in this parameter is undefined. @result Non-zero if canceled and zero if not canceled.

macrodispatch_testcancel

#define dispatch_testcancel(object) _Generic((object),
			dispatch_block_t:dispatch_block_testcancel,
			dispatch_source_t:dispatch_source_testcancel
		)((object))

functiondispatch_debug

API_DEPRECATED("unsupported interface", macos(10.6,10.9), ios(4.0,6.0)) DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW DISPATCH_COLD __attribute__((__format__(printf,2,3))) void dispatch_debug(
	dispatch_object_t object,
	const char *DISPATCH_UNSAFE_INDEXABLE message,
	...
)
deprecated
@function dispatch_debug @abstract Programmatically log debug information about a dispatch object. @discussion Programmatically log debug information about a dispatch object. By default, the log output is sent to syslog at notice level. In the debug version of the library, the log output is sent to a file in /var/tmp. The log output destination can be configured via the LIBDISPATCH_LOG environment variable, valid values are: YES, NO, syslog, stderr, file. This function is deprecated and will be removed in a future release. Objective-C callers may use -debugDescription instead. @param object The object to introspect. @param message The message to log above and beyond the introspection.

functiondispatch_debugv

API_DEPRECATED("unsupported interface", macos(10.6,10.9), ios(4.0,6.0)) DISPATCH_EXPORT DISPATCH_NONNULL2 DISPATCH_NOTHROW DISPATCH_COLD __attribute__((__format__(printf,2,0))) void dispatch_debugv(
	dispatch_object_t object,
	const char *DISPATCH_UNSAFE_INDEXABLE message,
	va_list ap
)
deprecated