1/* Copyright 2019 The TensorFlow Authors. All Rights Reserved.
2
3Licensed under the Apache License, Version 2.0 (the "License");
4you may not use this file except in compliance with the License.
5You may obtain a copy of the License at
6
7 http://www.apache.org/licenses/LICENSE-2.0
8
9Unless required by applicable law or agreed to in writing, software
10distributed under the License is distributed on an "AS IS" BASIS,
11WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12See the License for the specific language governing permissions and
13limitations under the License.
14==============================================================================*/
15#ifndef TENSORFLOW_CORE_FRAMEWORK_THREAD_FACTORY_H_
16#define TENSORFLOW_CORE_FRAMEWORK_THREAD_FACTORY_H_
17
18#include <functional>
19#include <memory>
20
21#include "tensorflow/core/platform/types.h"
22
23namespace tsl {
24class Thread;
25} // namespace tsl
26namespace tensorflow {
27using tsl::Thread; // NOLINT
28
29// Virtual interface for an object that creates threads.
30class ThreadFactory {
31 public:
32 virtual ~ThreadFactory() {}
33
34 // Runs `fn` asynchronously in a different thread. `fn` may block.
35 //
36 // NOTE: The caller is responsible for ensuring that this `ThreadFactory`
37 // outlives the returned `Thread`.
38 virtual std::unique_ptr<Thread> StartThread(const string& name,
39 std::function<void()> fn) = 0;
40};
41
42} // namespace tensorflow
43
44#endif // TENSORFLOW_CORE_FRAMEWORK_THREAD_FACTORY_H_
45