2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
22 #include <folly/Optional.h>
23 #include <folly/Range.h>
24 #include <folly/portability/Config.h>
25 #include <folly/portability/PThread.h>
30 * This returns true if the current platform supports setting the name of the
33 bool canSetCurrentThreadName();
36 * This returns true if the current platform supports setting the name of
37 * threads other than the one currently executing.
39 bool canSetOtherThreadName();
42 * Get the name of the given thread, or nothing if an error occurs
43 * or the functionality is not available.
45 Optional<std::string> getThreadName(std::thread::id tid);
48 * Equivalent to getThreadName(std::this_thread::get_id());
50 Optional<std::string> getCurrentThreadName();
53 * Set the name of the given thread.
54 * Returns false on failure, if an error occurs or the functionality
57 bool setThreadName(std::thread::id tid, StringPiece name);
58 #if FOLLY_HAVE_PTHREAD
59 bool setThreadName(pthread_t pid, StringPiece name);
63 * Equivalent to setThreadName(std::this_thread::get_id(), name);
65 bool setThreadName(StringPiece name);