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