aboutsummaryrefslogtreecommitdiff
path: root/Foundation/GTMSignalHandler.h
diff options
context:
space:
mode:
Diffstat (limited to 'Foundation/GTMSignalHandler.h')
-rw-r--r--Foundation/GTMSignalHandler.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/Foundation/GTMSignalHandler.h b/Foundation/GTMSignalHandler.h
new file mode 100644
index 0000000..da3a3ea
--- /dev/null
+++ b/Foundation/GTMSignalHandler.h
@@ -0,0 +1,75 @@
+//
+// GTMSignalHandler.h
+//
+// Copyright 2008 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not
+// use this file except in compliance with the License. You may obtain a copy
+// of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations under
+// the License.
+//
+
+#import <Foundation/Foundation.h>
+
+// GTMSignalHandler.
+//
+// This is a very simple, easy-to-use class for registering handlers that get
+// called when a specific signal is delivered. Also handy for ignoring
+// inconvenient signals. Ignoring SIGKILL is not support for what should be
+// obvious reasons.
+//
+// Example of how to catch SIGABRT and SIGTERM while ignring SIGWINCH:
+// GTMSignalHandler *abrt, *term, *winch;
+// abrt = [[GTMSignalHandler alloc]
+// initWithSignal:SIGABRT
+// target:self
+// handler:@selector(handleAbort:)];
+//
+// term = [[GTMSignalHandler alloc]
+// initWithSignal:SIGTERM
+// target:self
+// handler:@selector(handleTerm:)];
+//
+// winch = [[GTMSignalHandler alloc] initWithSignal:SIGWINCH
+// initWithSignal:SIGWINCH
+// target:nil
+// handler:NULL
+//
+// And then the signal handler has the triggered signal number boxed in an
+// NSNumber:
+// -(void)handleTerm:(NSNumber *)signo {
+// .. do stuff ..
+// }
+//
+// Release the handler when you're no longer interested in handling that signal.
+// Note that signal(SIG_IGN, signo) is performed on each signal handled by
+// objects of this class, and those do not get un-done.
+//
+// Multiple handlers for the same signal is NOT supported.
+//
+// kqueue() is used to handle the signals, and the default runloop for the first
+// signal handler is used for signal delivery, so keep that in mind when you're
+// using this class. This class explicitly does not handle arbitrary runloops
+// and threading.
+//
+@interface GTMSignalHandler : NSObject {
+ @private
+ int signo_;
+ __weak id target_;
+ SEL handler_;
+}
+
+// Returns a retained signal handler object that will invoke |handler| on the
+// |target| whenever a signal of number |signo| is delivered to the process.
+-(id)initWithSignal:(int)signo
+ target:(id)target
+ handler:(SEL)handler;
+
+@end // GTMSignalHandler