libXDispatch 0.5
Defines | Typedefs | Enumerations | Functions | Variables
include/libdispatch/source.h File Reference

Go to the source code of this file.

Defines

#define DISPATCH_SOURCE_TYPE_DATA_ADD   (&_dispatch_source_type_data_add)
#define DISPATCH_SOURCE_TYPE_DATA_OR   (&_dispatch_source_type_data_or)
#define DISPATCH_SOURCE_TYPE_MACH_SEND   (&_dispatch_source_type_mach_send)
#define DISPATCH_SOURCE_TYPE_MACH_RECV   (&_dispatch_source_type_mach_recv)
#define DISPATCH_SOURCE_TYPE_PROC   (&_dispatch_source_type_proc)
#define DISPATCH_SOURCE_TYPE_READ   (&_dispatch_source_type_read)
#define DISPATCH_SOURCE_TYPE_SIGNAL   (&_dispatch_source_type_signal)
#define DISPATCH_SOURCE_TYPE_TIMER   (&_dispatch_source_type_timer)
#define DISPATCH_SOURCE_TYPE_VNODE   (&_dispatch_source_type_vnode)
#define DISPATCH_SOURCE_TYPE_WRITE   (&_dispatch_source_type_write)

Typedefs

typedef struct
dispatch_source_type_s * 
dispatch_source_type_t

Enumerations

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
}

Functions

 DISPATCH_DECL (dispatch_source)
__DISPATCH_BEGIN_DECLS
DISPATCH_EXPORT
DISPATCH_MALLOC
DISPATCH_NOTHROW
dispatch_source_t 
dispatch_source_create (dispatch_source_type_t type, uintptr_t handle, unsigned long mask, dispatch_queue_t queue)
DISPATCH_EXPORT
DISPATCH_NONNULL1
DISPATCH_NOTHROW void 
dispatch_source_set_event_handler_f (dispatch_source_t source, dispatch_function_t handler)
DISPATCH_EXPORT
DISPATCH_NONNULL1
DISPATCH_NOTHROW void 
dispatch_source_set_cancel_handler_f (dispatch_source_t source, dispatch_function_t cancel_handler)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_source_cancel (dispatch_source_t source)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW long 
dispatch_source_testcancel (dispatch_source_t source)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_WARN_RESULT
DISPATCH_PURE DISPATCH_NOTHROW
uintptr_t 
dispatch_source_get_handle (dispatch_source_t source)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_WARN_RESULT
DISPATCH_PURE DISPATCH_NOTHROW
unsigned long 
dispatch_source_get_mask (dispatch_source_t source)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_WARN_RESULT
DISPATCH_PURE DISPATCH_NOTHROW
unsigned long 
dispatch_source_get_data (dispatch_source_t source)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_source_merge_data (dispatch_source_t source, unsigned long value)
DISPATCH_EXPORT
DISPATCH_NONNULL_ALL
DISPATCH_NOTHROW void 
dispatch_source_set_timer (dispatch_source_t source, dispatch_time_t start, uint64_t interval, uint64_t leeway)

Variables

DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_data_add
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_data_or
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_mach_send
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_mach_recv
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_proc
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_read
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_signal
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_timer
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_vnode
DISPATCH_EXPORT struct
dispatch_source_type_s 
_dispatch_source_type_write

Define Documentation

#define DISPATCH_SOURCE_TYPE_DATA_ADD   (&_dispatch_source_type_data_add)

DISPATCH_SOURCE_TYPE_DATA_ADD A dispatch source that coalesces data obtained via calls to dispatch_source_merge_data(). An ADD is used to coalesce the data. The handle is unused (pass zero for now). The mask is unused (pass zero for now).

#define DISPATCH_SOURCE_TYPE_DATA_OR   (&_dispatch_source_type_data_or)

DISPATCH_SOURCE_TYPE_DATA_OR A dispatch source that coalesces data obtained via calls to dispatch_source_merge_data(). A logical OR is used to coalesce the data. The handle is unused (pass zero for now). The mask is used to perform a logical AND with the value passed to dispatch_source_merge_data().

#define DISPATCH_SOURCE_TYPE_MACH_RECV   (&_dispatch_source_type_mach_recv)

DISPATCH_SOURCE_TYPE_MACH_RECV A dispatch source that monitors a Mach port for pending messages. The handle is a Mach port with a receive right (mach_port_t). The mask is unused (pass zero for now).

#define DISPATCH_SOURCE_TYPE_MACH_SEND   (&_dispatch_source_type_mach_send)

DISPATCH_SOURCE_TYPE_MACH_SEND A dispatch source that monitors a Mach port for dead name notifications (send right no longer has any corresponding receive right). The handle is a Mach port with a send or send-once right (mach_port_t). The mask is a mask of desired events from dispatch_source_mach_send_flags_t.

#define DISPATCH_SOURCE_TYPE_PROC   (&_dispatch_source_type_proc)

DISPATCH_SOURCE_TYPE_PROC A dispatch source that monitors an external process for events defined by dispatch_source_proc_flags_t. The handle is a process identifier (pid_t). The mask is a mask of desired events from dispatch_source_proc_flags_t.

#define DISPATCH_SOURCE_TYPE_READ   (&_dispatch_source_type_read)

DISPATCH_SOURCE_TYPE_READ A dispatch source that monitors a file descriptor for pending bytes available to be read. The handle is a file descriptor (int). The mask is unused (pass zero for now).

#define DISPATCH_SOURCE_TYPE_SIGNAL   (&_dispatch_source_type_signal)

DISPATCH_SOURCE_TYPE_SIGNAL A dispatch source that monitors the current process for signals. The handle is a signal number (int). The mask is unused (pass zero for now).

#define DISPATCH_SOURCE_TYPE_TIMER   (&_dispatch_source_type_timer)

DISPATCH_SOURCE_TYPE_TIMER A dispatch source that submits the event handler block based on a timer. The handle is unused (pass zero for now). The mask is unused (pass zero for now).

#define DISPATCH_SOURCE_TYPE_VNODE   (&_dispatch_source_type_vnode)

DISPATCH_SOURCE_TYPE_VNODE A dispatch source that monitors a file descriptor for events defined by dispatch_source_vnode_flags_t. The handle is a file descriptor (int). The mask is a mask of desired events from dispatch_source_vnode_flags_t.

#define DISPATCH_SOURCE_TYPE_WRITE   (&_dispatch_source_type_write)

DISPATCH_SOURCE_TYPE_WRITE A dispatch source that monitors a file descriptor for available buffer space to write bytes. The handle is a file descriptor (int). The mask is unused (pass zero for now).


Typedef Documentation

Constants of this type represent the class of low-level system object that is being monitored by the dispatch source. Constants of this type are passed as a parameter to dispatch_source_create() and determine how the handle argument is interpreted (i.e. as a file descriptor, mach port, signal number, process identifer, etc.), and how the mask arugment is interpreted.


Enumeration Type Documentation

anonymous enum
Enumerator:
DISPATCH_MACH_SEND_DEAD 
anonymous enum
Enumerator:
DISPATCH_PROC_EXIT 
DISPATCH_PROC_FORK 
DISPATCH_PROC_EXEC 
DISPATCH_PROC_SIGNAL 
anonymous enum
Enumerator:
DISPATCH_VNODE_DELETE 
DISPATCH_VNODE_WRITE 
DISPATCH_VNODE_EXTEND 
DISPATCH_VNODE_ATTRIB 
DISPATCH_VNODE_LINK 
DISPATCH_VNODE_RENAME 
DISPATCH_VNODE_REVOKE 

Function Documentation

DISPATCH_DECL ( dispatch_source  )
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_source_cancel ( dispatch_source_t  source)

dispatch_source_cancel

Asynchronously cancel the dispatch source, preventing any further invocation of its event handler block.

Cancellation prevents any further invocation of the event handler block for the specified dispatch source, but does not interrupt an event handler block that is already in progress.

The cancellation handler is submitted to the source's target queue once the the source's event handler has finished, indicating it is now safe to close the source's handle (i.e. file descriptor or mach port).

See dispatch_source_set_cancel_handler() for more information.

Parameters:
sourceThe dispatch source to be canceled. The result of passing NULL in this parameter is undefined.
__DISPATCH_BEGIN_DECLS DISPATCH_EXPORT DISPATCH_MALLOC DISPATCH_NOTHROW dispatch_source_t dispatch_source_create ( dispatch_source_type_t  type,
uintptr_t  handle,
unsigned long  mask,
dispatch_queue_t  queue 
)

dispatch_source_create

Creates a new dispatch source to monitor low-level system objects and auto- matically submit a handler block to a dispatch queue in response to events.

Dispatch sources are not reentrant. Any events received while the dispatch source is suspended or while the event handler block is currently executing will be coalesced and delivered after the dispatch source is resumed or the event handler block has returned.

Dispatch sources are created in a suspended state. After creating the source and setting any desired attributes (i.e. the handler, context, etc.), a call must be made to dispatch_resume() in order to begin event delivery.

Parameters:
typeDeclares the type of the dispatch source. Must be one of the defined dispatch_source_type_t constants.
handleThe underlying system handle to monitor. The interpretation of this argument is determined by the constant provided in the type parameter.
maskA mask of flags specifying which events are desired. The interpretation of this argument is determined by the constant provided in the type parameter.
queueThe dispatch queue to which the event handler block will be submited.
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_WARN_RESULT DISPATCH_PURE DISPATCH_NOTHROW unsigned long dispatch_source_get_data ( dispatch_source_t  source)

dispatch_source_get_data

Returns pending data for the dispatch source.

This function is intended to be called from within the event handler block. The result of calling this function outside of the event handler callback is undefined.

Parameters:
sourceThe result of passing NULL in this parameter is undefined.
Returns:
The return value should be interpreted according to the type of the dispatch source, and may be one of the following:

DISPATCH_SOURCE_TYPE_DATA_ADD: application defined data DISPATCH_SOURCE_TYPE_DATA_OR: application defined data DISPATCH_SOURCE_TYPE_MACH_SEND: dispatch_source_mach_send_flags_t DISPATCH_SOURCE_TYPE_MACH_RECV: n/a DISPATCH_SOURCE_TYPE_PROC: dispatch_source_proc_flags_t DISPATCH_SOURCE_TYPE_READ: estimated bytes available to read DISPATCH_SOURCE_TYPE_SIGNAL: number of signals delivered since the last handler invocation DISPATCH_SOURCE_TYPE_TIMER: number of times the timer has fired since the last handler invocation DISPATCH_SOURCE_TYPE_VNODE: dispatch_source_vnode_flags_t DISPATCH_SOURCE_TYPE_WRITE: estimated buffer space available

DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_WARN_RESULT DISPATCH_PURE DISPATCH_NOTHROW uintptr_t dispatch_source_get_handle ( dispatch_source_t  source)

dispatch_source_get_handle

Returns the underlying system handle associated with this dispatch source.

Parameters:
sourceThe result of passing NULL in this parameter is undefined.
Returns:
The return value should be interpreted according to the type of the dispatch source, and may be one of the following handles:

DISPATCH_SOURCE_TYPE_DATA_ADD: n/a DISPATCH_SOURCE_TYPE_DATA_OR: n/a DISPATCH_SOURCE_TYPE_MACH_SEND: mach port (mach_port_t) DISPATCH_SOURCE_TYPE_MACH_RECV: mach port (mach_port_t) DISPATCH_SOURCE_TYPE_PROC: process identifier (pid_t) DISPATCH_SOURCE_TYPE_READ: file descriptor (int) DISPATCH_SOURCE_TYPE_SIGNAL: signal number (int) DISPATCH_SOURCE_TYPE_TIMER: n/a DISPATCH_SOURCE_TYPE_VNODE: file descriptor (int) DISPATCH_SOURCE_TYPE_WRITE: file descriptor (int)

DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_WARN_RESULT DISPATCH_PURE DISPATCH_NOTHROW unsigned long dispatch_source_get_mask ( dispatch_source_t  source)

dispatch_source_get_mask

Returns the mask of events monitored by the dispatch source.

Parameters:
sourceThe result of passing NULL in this parameter is undefined.
Returns:
The return value should be interpreted according to the type of the dispatch source, and may be one of the following flag sets:

DISPATCH_SOURCE_TYPE_DATA_ADD: n/a DISPATCH_SOURCE_TYPE_DATA_OR: n/a DISPATCH_SOURCE_TYPE_MACH_SEND: dispatch_source_mach_send_flags_t DISPATCH_SOURCE_TYPE_MACH_RECV: n/a DISPATCH_SOURCE_TYPE_PROC: dispatch_source_proc_flags_t DISPATCH_SOURCE_TYPE_READ: n/a DISPATCH_SOURCE_TYPE_SIGNAL: n/a DISPATCH_SOURCE_TYPE_TIMER: n/a DISPATCH_SOURCE_TYPE_VNODE: dispatch_source_vnode_flags_t DISPATCH_SOURCE_TYPE_WRITE: n/a

DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_source_merge_data ( dispatch_source_t  source,
unsigned long  value 
)

dispatch_source_merge_data

Merges data into a dispatch source of type DISPATCH_SOURCE_TYPE_DATA_ADD or DISPATCH_SOURCE_TYPE_DATA_OR and submits its event handler block to its target queue.

Parameters:
sourceThe result of passing NULL in this parameter is undefined.
valueThe value to coalesce with the pending data using a logical OR or an ADD as specified by the dispatch source type. A value of zero has no effect and will not result in the submission of the event handler block.
DISPATCH_EXPORT DISPATCH_NONNULL1 DISPATCH_NOTHROW void dispatch_source_set_cancel_handler_f ( dispatch_source_t  source,
dispatch_function_t  cancel_handler 
)

dispatch_source_set_cancel_handler

Sets the cancellation handler block for the given dispatch source.

The cancellation handler (if specified) will be submitted to the source's target queue in response to a call to dispatch_source_cancel() once the system has released all references to the source's underlying handle and the source's event handler block has returned.

IMPORTANT: A cancellation handler is required for file descriptor and mach port based sources in order to safely close the descriptor or destroy the port. Closing the descriptor or port before the cancellation handler may result in a race condition. If a new descriptor is allocated with the same value as the recently closed descriptor while the source's event handler is still running, the event handler may read/write data to the wrong descriptor.

Parameters:
sourceThe dispatch source to modify. The result of passing NULL in this parameter is undefined.
handlerThe cancellation handler block to submit to the source's target queue.

dispatch_source_set_cancel_handler_f

Sets the cancellation handler function for the given dispatch source.

See dispatch_source_set_cancel_handler() for more details.

Parameters:
sourceThe dispatch source to modify. The result of passing NULL in this parameter is undefined.
handlerThe cancellation handler function to submit to the source's target queue. The context parameter passed to the event handler function is the current context of the dispatch source at the time the handler call is made.
DISPATCH_EXPORT DISPATCH_NONNULL1 DISPATCH_NOTHROW void dispatch_source_set_event_handler_f ( dispatch_source_t  source,
dispatch_function_t  handler 
)

dispatch_source_set_event_handler

Sets the event handler block for the given dispatch source.

Parameters:
sourceThe dispatch source to modify. The result of passing NULL in this parameter is undefined.
handlerThe event handler block to submit to the source's target queue.

dispatch_source_set_event_handler_f

Sets the event handler function for the given dispatch source.

Parameters:
sourceThe dispatch source to modify. The result of passing NULL in this parameter is undefined.
handlerThe event handler function to submit to the source's target queue. The context parameter passed to the event handler function is the current context of the dispatch source at the time the handler call is made. The result of passing NULL in this parameter is undefined.
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW void dispatch_source_set_timer ( dispatch_source_t  source,
dispatch_time_t  start,
uint64_t  interval,
uint64_t  leeway 
)

dispatch_source_set_timer

Sets a start time, interval, and leeway value for a timer source.

Calling this function has no effect if the timer source has already been canceled.

The start time argument also determines which clock will be used for the timer. If the start time is DISPATCH_TIME_NOW or created with dispatch_time() then the timer is based on mach_absolute_time(). Otherwise, if the start time of the timer is created with dispatch_walltime() then the timer is based on gettimeofday(3).

Parameters:
startThe start time of the timer. See dispatch_time() and dispatch_walltime() for more information.
intervalThe nanosecond interval for the timer.
leewayA hint given to the system by the application for the amount of leeway, in nanoseconds, that the system may defer the timer in order to align with other system activity for improved system performance or power consumption. (For example, an application might perform a periodic task every 5 minutes, with a leeway of up to 30 seconds.) Note that some latency is to be expected for all timers even when a leeway value of zero is specified.
DISPATCH_EXPORT DISPATCH_NONNULL_ALL DISPATCH_NOTHROW long dispatch_source_testcancel ( dispatch_source_t  source)

dispatch_source_testcancel

Tests whether the given dispatch source has been canceled.

Parameters:
sourceThe dispatch source to be tested. The result of passing NULL in this parameter is undefined.
Returns:
Non-zero if canceled and zero if not canceled.

Variable Documentation

DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_data_add
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_data_or
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_mach_recv
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_mach_send
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_proc
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_read
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_signal
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_timer
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_vnode
DISPATCH_EXPORT struct dispatch_source_type_s _dispatch_source_type_write

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