include/libdispatch/queue.h

Go to the documentation of this file.

/*
* Copyright (c) 2008-2009 Apple Inc. All rights reserved.
* Copyright (c) 2011 MLBA. All rights reserved.
*
* @MLBA_OPEN_LICENSE_HEADER_START@
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* 
*     http://www.apache.org/licenses/LICENSE-2.0
* 
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @MLBA_OPEN_LICENSE_HEADER_END@
*/



#ifndef __DISPATCH_QUEUE__
#define __DISPATCH_QUEUE__

#ifndef __DISPATCH_INDIRECT__
#error "Please #include <xdispatch/dispatch.h> instead of this file directly."
#include "base.h" // for HeaderDoc
#endif

DISPATCH_DECL(dispatch_queue);

DISPATCH_DECL(dispatch_queue_attr);

#ifdef __BLOCKS__
typedef void (dispatch_block_t)(void);
#endif

__DISPATCH_BEGIN_DECLS

DISPATCH_EXPORT void
dispatch_async_f(dispatch_queue_t queue,
       void *context,
       dispatch_function_t work);


DISPATCH_EXPORT void
dispatch_sync_f(dispatch_queue_t queue,
       void *context,
       dispatch_function_t work);

DISPATCH_EXPORT void
dispatch_apply_f(size_t iterations, dispatch_queue_t queue,
       void *context,
       void (*work)(void *, size_t));

DISPATCH_EXPORT dispatch_queue_t
dispatch_get_current_queue(void);

DISPATCH_EXPORT dispatch_queue_t dispatch_get_main_queue();

enum {
       DISPATCH_QUEUE_PRIORITY_HIGH = 2,
       DISPATCH_QUEUE_PRIORITY_DEFAULT = 0,
       DISPATCH_QUEUE_PRIORITY_LOW = -2,
};

DISPATCH_EXPORT dispatch_queue_t
dispatch_get_global_queue(long priority, unsigned long flags);

DISPATCH_EXPORT dispatch_queue_t
dispatch_queue_create(const char *label, dispatch_queue_attr_t attr);

DISPATCH_EXPORT const char *
dispatch_queue_get_label(dispatch_queue_t queue);

DISPATCH_EXPORT void
dispatch_set_target_queue(dispatch_object_t object, dispatch_queue_t queue);

DISPATCH_EXPORT void
dispatch_main(void);

DISPATCH_EXPORT void
dispatch_after_f(dispatch_time_t when,
       dispatch_queue_t queue,
       void *context,
       dispatch_function_t work);

__DISPATCH_END_DECLS

#ifdef XDISPATCH_HAS_BLOCKS

DISPATCH_EXPORT void
dispatch_async(dispatch_queue_t queue, dispatch_block_t block);


DISPATCH_EXPORT void
dispatch_after(dispatch_time_t when,
       dispatch_queue_t queue,
       dispatch_block_t block);


DISPATCH_EXPORT void
dispatch_sync(dispatch_queue_t queue, dispatch_block_t block);

DISPATCH_EXPORT void
dispatch_apply(size_t iterations, dispatch_queue_t queue, dispatch_iteration_block_t block);

#endif

#endif