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