1/*
2 * Copyright 2014-present Facebook, Inc.
3 *
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
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17#pragma once
18
19#include <string>
20#include <thread>
21
22#include <folly/Optional.h>
23#include <folly/Range.h>
24#include <folly/portability/Config.h>
25#include <folly/portability/PThread.h>
26
27namespace folly {
28
29/**
30 * This returns true if the current platform supports setting the name of the
31 * current thread.
32 */
33bool canSetCurrentThreadName();
34
35/**
36 * This returns true if the current platform supports setting the name of
37 * threads other than the one currently executing.
38 */
39bool canSetOtherThreadName();
40
41/**
42 * Get the name of the given thread, or nothing if an error occurs
43 * or the functionality is not available.
44 */
45Optional<std::string> getThreadName(std::thread::id tid);
46
47/**
48 * Equivalent to getThreadName(std::this_thread::get_id());
49 */
50Optional<std::string> getCurrentThreadName();
51
52/**
53 * Set the name of the given thread.
54 * Returns false on failure, if an error occurs or the functionality
55 * is not available.
56 */
57bool setThreadName(std::thread::id tid, StringPiece name);
58bool setThreadName(pthread_t pid, StringPiece name);
59
60/**
61 * Equivalent to setThreadName(std::this_thread::get_id(), name);
62 */
63bool setThreadName(StringPiece name);
64} // namespace folly
65