OSX/libsecurity_utilities/lib/machrunloopserver.h

   1 /*
   2  * Copyright (c) 2000-2001,2003-2004,2011-2012,2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 //
  26 // machrunloopserver - C++ shell for writing Mach 3 servers called by CFRunLoop.
  27 //
  28 // Note that this is a subclass of MachServer and tries to preserve its interface,
  29 // so you can switch back-and-forth between them with a minimum of fuss.
  30 // Timers are not currently implemented; they're not that hard to add if you need them.
  31 //
  32 #ifndef _H_MACHRUNLOOPSERVER
  33 #define _H_MACHRUNLOOPSERVER
  34
  35 #include <security_utilities/machserver.h>
  36 #include <security_utilities/cfmach++.h>
  37 #include <CoreFoundation/CFRunLoop.h>
  38 #include <CoreFoundation/CFMachPort.h>
  39
  40
  41 namespace Security {
  42 namespace MachPlusPlus {
  43
  44
  45 //
  46 // A Mach server object variant for use with CFRunLoops
  47 //
  48 // This currently only supports a subset of full MachServer functionality.
  49 //
  50 class MachRunLoopServer : public MachServer, private CFAutoPort {
  51 public:
  52         MachRunLoopServer();            // anonymous
  53         MachRunLoopServer(const char *name); // register by name
  54         MachRunLoopServer(const char *name, const Bootstrap &boot); // register in bootstrap
  55         virtual ~MachRunLoopServer();
  56
  57         void run(mach_msg_size_t maxSize = 4096, mach_msg_options_t options = 0);
  58
  59         static MachRunLoopServer &active()
  60         { return safer_cast<MachRunLoopServer &>(MachServer::active()); }
  61
  62         void notifyIfDead(Port port, bool doNotify = true) const;
  63
  64 protected:
  65         void receive(const Message &request);
  66         void oneRequest(const Message &request);
  67
  68 private:
  69         static void cfInvalidate(CFMachPortRef port, void *info);
  70
  71 private:
  72         Message mReplyMessage;
  73 };
  74
  75
  76 } // end namespace MachPlusPlus
  77
  78 } // end namespace Security
  79
  80 #endif //_H_MACHRUNLOOPSERVER