lib/cpp/src/thrift/concurrency/ThreadFactory.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.
 */

#ifndef _THRIFT_CONCURRENCY_THREADFACTORY_H_
#define _THRIFT_CONCURRENCY_THREADFACTORY_H_ 1

#include <thrift/concurrency/Thread.h>

#include <memory>
namespace apache {
namespace thrift {
namespace concurrency {

/**
 * Factory to create thread object and bind them to Runnable
 * object for execution
 */
class ThreadFactory {
public:
  /**
   * All threads created by a factory are reference-counted
   * via std::shared_ptr.  The factory guarantees that threads and the Runnable tasks
   * they host will be properly cleaned up once the last strong reference
   * to both is given up.
   *
   * By default threads are not joinable.
   */
  ThreadFactory(bool detached = true) : detached_(detached) { }

  virtual ~ThreadFactory() = default;

  /**
   * Gets current detached mode
   */
  bool isDetached() const { return detached_; }

  /**
   * Sets the detached disposition of newly created threads.
   */
  void setDetached(bool detached) { detached_ = detached; }

  /**
   * Create a new thread.
   */
  virtual std::shared_ptr<Thread> newThread(std::shared_ptr<Runnable> runnable) const;

  /**
   * Gets the current thread id or unknown_thread_id if the current thread is not a thrift thread
   */
  Thread::id_t getCurrentThreadId() const;

private:
  bool detached_;
};

}
}
} // apache::thrift::concurrency

#endif // #ifndef _THRIFT_CONCURRENCY_THREADFACTORY_H_