replace getnameinfo with inet_ntop in v6 string formatting
[folly.git] / folly / ThreadName.h
index 2d30efa0af94f1ede599bf0b19d8fe546eaf944d..ba7bde25953925e451fdc447af422643365edacd 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 #pragma once
 
-#include <pthread.h>
-#include "Range.h"
+#include <string>
+#include <thread>
+
+#include <folly/Optional.h>
+#include <folly/Range.h>
+#include <folly/portability/Config.h>
+#include <folly/portability/PThread.h>
 
 namespace folly {
 
-inline bool setThreadName(pthread_t id, StringPiece name) {
-#if (defined(__GLIBC__) && __GLIBC_PREREQ(2, 12))
-  return 0 == pthread_setname_np(id, name.fbstr().substr(0, 15).c_str());
-#else
-  return false;
-#endif
-}
+/**
+ * This returns true if the current platform supports setting the name of the
+ * current thread.
+ */
+bool canSetCurrentThreadName();
 
-inline bool setThreadName(StringPiece name) {
-  return setThreadName(pthread_self(), name);
-}
+/**
+ * This returns true if the current platform supports setting the name of
+ * threads other than the one currently executing.
+ */
+bool canSetOtherThreadName();
+
+/**
+ * Get the name of the given thread, or nothing if an error occurs
+ * or the functionality is not available.
+ */
+Optional<std::string> getThreadName(std::thread::id tid);
+
+/**
+ * Equivalent to getThreadName(std::this_thread::get_id());
+ */
+Optional<std::string> getCurrentThreadName();
 
+/**
+ * Set the name of the given thread.
+ * Returns false on failure, if an error occurs or the functionality
+ * is not available.
+ */
+bool setThreadName(std::thread::id tid, StringPiece name);
+#if FOLLY_HAVE_PTHREAD
+bool setThreadName(pthread_t pid, StringPiece name);
+#endif
+
+/**
+ * Equivalent to setThreadName(std::this_thread::get_id(), name);
+ */
+bool setThreadName(StringPiece name);
 }