iokit/DriverKit/IODispatchSource.iig

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