include/libdispatch/source.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_SOURCE__
#define __DISPATCH_SOURCE__

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

DISPATCH_DECL(dispatch_source);

typedef const struct dispatch_source_type_s *dispatch_source_type_t;

#define DISPATCH_SOURCE_TYPE_DATA_ADD (&_dispatch_source_type_data_add)
const struct dispatch_source_type_s _dispatch_source_type_data_add;

#define DISPATCH_SOURCE_TYPE_DATA_OR (&_dispatch_source_type_data_or)
const struct dispatch_source_type_s _dispatch_source_type_data_or;

#define DISPATCH_SOURCE_TYPE_MACH_SEND (&_dispatch_source_type_mach_send)
const struct dispatch_source_type_s _dispatch_source_type_mach_send;

#define DISPATCH_SOURCE_TYPE_MACH_RECV (&_dispatch_source_type_mach_recv)
const struct dispatch_source_type_s _dispatch_source_type_mach_recv;

#define DISPATCH_SOURCE_TYPE_PROC (&_dispatch_source_type_proc)
const struct dispatch_source_type_s _dispatch_source_type_proc;

#define DISPATCH_SOURCE_TYPE_READ (&_dispatch_source_type_read)
const struct dispatch_source_type_s _dispatch_source_type_read;

#define DISPATCH_SOURCE_TYPE_SIGNAL (&_dispatch_source_type_signal)
const struct dispatch_source_type_s _dispatch_source_type_signal;

#define DISPATCH_SOURCE_TYPE_TIMER (&_dispatch_source_type_timer)
const struct dispatch_source_type_s _dispatch_source_type_timer;

#define DISPATCH_SOURCE_TYPE_VNODE (&_dispatch_source_type_vnode)
const struct dispatch_source_type_s _dispatch_source_type_vnode;

#define DISPATCH_SOURCE_TYPE_WRITE (&_dispatch_source_type_write)
const struct dispatch_source_type_s _dispatch_source_type_write;

enum {
       DISPATCH_MACH_SEND_DEAD = 0x1,
};

enum {
       DISPATCH_PROC_EXIT = 0x80000000,
       DISPATCH_PROC_FORK = 0x40000000,
       DISPATCH_PROC_EXEC = 0x20000000,
       DISPATCH_PROC_SIGNAL = 0x08000000,
};

enum {
       DISPATCH_VNODE_DELETE = 0x1,
       DISPATCH_VNODE_WRITE = 0x2,
       DISPATCH_VNODE_EXTEND = 0x4,
       DISPATCH_VNODE_ATTRIB = 0x8,
       DISPATCH_VNODE_LINK  = 0x10,
       DISPATCH_VNODE_RENAME = 0x20,
       DISPATCH_VNODE_REVOKE = 0x40,
};

__DISPATCH_BEGIN_DECLS

dispatch_source_t
dispatch_source_create(dispatch_source_type_t type,
       uintptr_t handle,
       unsigned long mask,
       dispatch_queue_t queue);

#ifdef XDISPATCH_HAS_BLOCKS
void
dispatch_source_set_event_handler(dispatch_source_t source,
       dispatch_block_t handler);
#endif /* XDISPATCH_HAS_BLOCKS */

void
dispatch_source_set_event_handler_f(dispatch_source_t source,
       dispatch_function_t handler);

#ifdef XDISPATCH_HAS_BLOCKS
void
dispatch_source_set_cancel_handler(dispatch_source_t source,
       dispatch_block_t cancel_handler);
#endif /* XDISPATCH_HAS_BLOCKS */

void
dispatch_source_set_cancel_handler_f(dispatch_source_t source,
       dispatch_function_t cancel_handler);

void
dispatch_source_cancel(dispatch_source_t source);

long
dispatch_source_testcancel(dispatch_source_t source);

uintptr_t
dispatch_source_get_handle(dispatch_source_t source);

unsigned long
dispatch_source_get_mask(dispatch_source_t source);

unsigned long
dispatch_source_get_data(dispatch_source_t source);

void
dispatch_source_merge_data(dispatch_source_t source, unsigned long value);

void
dispatch_source_set_timer(dispatch_source_t source,
       dispatch_time_t start,
       uint64_t interval,
       uint64_t leeway);

__DISPATCH_END_DECLS

#endif