blob: b7d09d182ba434174c4f18143403532de5c23e06 [file] [log] [blame]
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef FLUTTER_FML_THREAD_H_
#define FLUTTER_FML_THREAD_H_
#include <atomic>
#include <functional>
#include <memory>
#include <string>
#include "flutter/fml/macros.h"
#include "flutter/fml/task_runner.h"
namespace fml {
class ThreadHandle;
class Thread {
public:
/// Valid values for priority of Thread.
enum class ThreadPriority : int {
/// Suitable for threads that shouldn't disrupt high priority work.
kBackground,
/// Default priority level.
kNormal,
/// Suitable for threads which generate data for the display.
kDisplay,
/// Suitable for thread which raster data.
kRaster,
};
/// The ThreadConfig is the thread info include thread name, thread priority.
struct ThreadConfig {
ThreadConfig(const std::string& name, ThreadPriority priority)
: name(name), priority(priority) {}
explicit ThreadConfig(const std::string& name)
: ThreadConfig(name, ThreadPriority::kNormal) {}
ThreadConfig() : ThreadConfig("", ThreadPriority::kNormal) {}
std::string name;
ThreadPriority priority;
};
using ThreadConfigSetter = std::function<void(const ThreadConfig&)>;
explicit Thread(const std::string& name = "");
explicit Thread(const ThreadConfigSetter& setter,
const ThreadConfig& config = ThreadConfig());
~Thread();
fml::RefPtr<fml::TaskRunner> GetTaskRunner() const;
void Join();
static void SetCurrentThreadName(const ThreadConfig& config);
static size_t GetDefaultStackSize();
private:
std::unique_ptr<ThreadHandle> thread_;
fml::RefPtr<fml::TaskRunner> task_runner_;
std::atomic_bool joined_;
FML_DISALLOW_COPY_AND_ASSIGN(Thread);
};
} // namespace fml
#endif // FLUTTER_FML_THREAD_H_