xref: /xnu-12377.1.9/iokit/DriverKit/IODispatchSource.iig (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1*f6217f89SApple OSS Distributions/*
2*f6217f89SApple OSS Distributions * Copyright (c) 2019-2019 Apple Inc. All rights reserved.
3*f6217f89SApple OSS Distributions *
4*f6217f89SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*f6217f89SApple OSS Distributions *
6*f6217f89SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code
7*f6217f89SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License
8*f6217f89SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in
9*f6217f89SApple OSS Distributions * compliance with the License. The rights granted to you under the License
10*f6217f89SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of,
11*f6217f89SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to
12*f6217f89SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any
13*f6217f89SApple OSS Distributions * terms of an Apple operating system software license agreement.
14*f6217f89SApple OSS Distributions *
15*f6217f89SApple OSS Distributions * Please obtain a copy of the License at
16*f6217f89SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*f6217f89SApple OSS Distributions *
18*f6217f89SApple OSS Distributions * The Original Code and all software distributed under the License are
19*f6217f89SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*f6217f89SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*f6217f89SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*f6217f89SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*f6217f89SApple OSS Distributions * Please see the License for the specific language governing rights and
24*f6217f89SApple OSS Distributions * limitations under the License.
25*f6217f89SApple OSS Distributions *
26*f6217f89SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*f6217f89SApple OSS Distributions */
28*f6217f89SApple OSS Distributions
29*f6217f89SApple OSS Distributions#ifndef _IOKIT_UIODISPATCHSOURCE_H
30*f6217f89SApple OSS Distributions#define _IOKIT_UIODISPATCHSOURCE_H
31*f6217f89SApple OSS Distributions
32*f6217f89SApple OSS Distributions#include <DriverKit/OSObject.iig>
33*f6217f89SApple OSS Distributions
34*f6217f89SApple OSS Distributions
35*f6217f89SApple OSS Distributionstypedef void (^IODispatchSourceCancelHandler)(void);
36*f6217f89SApple OSS Distributions
37*f6217f89SApple OSS Distributions/*!
38*f6217f89SApple OSS Distributions * @class IODispatchSource
39*f6217f89SApple OSS Distributions
40*f6217f89SApple OSS Distributions * @abstract
41*f6217f89SApple OSS Distributions * IODispatchSource common base class for dispatch sources.
42*f6217f89SApple OSS Distributions */
43*f6217f89SApple OSS Distributions
44*f6217f89SApple OSS Distributionsclass NATIVE KERNEL IODispatchSource : public OSObject
45*f6217f89SApple OSS Distributions{
46*f6217f89SApple OSS Distributionspublic:
47*f6217f89SApple OSS Distributions
48*f6217f89SApple OSS Distributions	virtual bool
49*f6217f89SApple OSS Distributions	init() override;
50*f6217f89SApple OSS Distributions
51*f6217f89SApple OSS Distributions	virtual void
52*f6217f89SApple OSS Distributions	free() override;
53*f6217f89SApple OSS Distributions
54*f6217f89SApple OSS Distributions	virtual kern_return_t
55*f6217f89SApple OSS Distributions	Cancel(IODispatchSourceCancelHandler handler) = 0;
56*f6217f89SApple OSS Distributions
57*f6217f89SApple OSS Distributions	virtual kern_return_t
58*f6217f89SApple OSS Distributions	SetEnableWithCompletion(
59*f6217f89SApple OSS Distributions		bool enable,
60*f6217f89SApple OSS Distributions		IODispatchSourceCancelHandler handler) = 0;
61*f6217f89SApple OSS Distributions
62*f6217f89SApple OSS Distributions	virtual kern_return_t
63*f6217f89SApple OSS Distributions	CheckForWork(bool synchronous) INVOKEREPLY = 0;
64*f6217f89SApple OSS Distributions
65*f6217f89SApple OSS Distributions	virtual kern_return_t
66*f6217f89SApple OSS Distributions	SetEnable(bool enable) LOCAL;
67*f6217f89SApple OSS Distributions};
68*f6217f89SApple OSS Distributions
69*f6217f89SApple OSS Distributions#endif /* ! _IOKIT_UIODISPATCHSOURCE_H */
70