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