From: Lucian Grijincu Date: Mon, 31 Oct 2016 19:56:26 +0000 (-0700) Subject: folly: AsyncSignalHandler: update comments to match code X-Git-Tag: v2016.11.07.00~25 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=21d7adcd34a367bd6708a2438161b92307c4b53f;p=folly.git folly: AsyncSignalHandler: update comments to match code Summary: #accept2ship Reviewed By: jsedgwick Differential Revision: D4105140 fbshipit-source-id: eca1f7066e514ec3c5d316f974edc34e03872784 --- diff --git a/folly/io/async/AsyncSignalHandler.h b/folly/io/async/AsyncSignalHandler.h index 213197e0..7d669ffb 100644 --- a/folly/io/async/AsyncSignalHandler.h +++ b/folly/io/async/AsyncSignalHandler.h @@ -24,17 +24,19 @@ namespace folly { /** * A handler to receive notification about POSIX signals. * - * TAsyncSignalHandler allows code to process signals from within a EventBase - * loop. Standard signal handlers interrupt execution of the main thread, and + * AsyncSignalHandler allows code to process signals from within a EventBase + * loop. + * + * Standard signal handlers interrupt execution of the main thread, and * are run while the main thread is paused. As a result, great care must be * taken to avoid race conditions if the signal handler has to access or modify * any data used by the main thread. * - * TAsyncSignalHandler solves this problem by running the TAsyncSignalHandler + * AsyncSignalHandler solves this problem by running the AsyncSignalHandler * callback in normal thread of execution, as a EventBase callback. * - * TAsyncSignalHandler may only be used in a single thread. It will only - * process signals received by the thread where the TAsyncSignalHandler is + * AsyncSignalHandler may only be used in a single thread. It will only + * process signals received by the thread where the AsyncSignalHandler is * registered. It is the user's responsibility to ensure that signals are * delivered to the desired thread in multi-threaded programs. */ @@ -53,7 +55,7 @@ class AsyncSignalHandler { * signalReceived() will be called each time this thread receives this * signal. * - * Throws a TException if an error occurs, or if this handler is already + * Throws if an error occurs or if this handler is already * registered for this signal. */ void registerSignalHandler(int signum); @@ -61,8 +63,7 @@ class AsyncSignalHandler { /** * Unregister for callbacks about the specified signal. * - * Throws a TException if an error occurs, or if this signal was not - * registered. + * Throws if an error occurs, or if this signal was not registered. */ void unregisterSignalHandler(int signum);