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