api/task_queue/task_queue_factory.h

/*
 *  Copyright 2019 The WebRTC Project Authors. All rights reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */
#ifndef API_TASK_QUEUE_TASK_QUEUE_FACTORY_H_
#define API_TASK_QUEUE_TASK_QUEUE_FACTORY_H_

#include <memory>

#include "absl/strings/string_view.h"
#include "api/task_queue/task_queue_base.h"

namespace webrtc {

// The implementation of this interface must be thread-safe.
class TaskQueueFactory {
 public:
  // TaskQueue priority levels. On some platforms these will map to thread
  // priorities, on others such as Mac and iOS, GCD queue priorities.
  enum class Priority {
    // Default priority.
    kNormal = 0,
    // High priority. Use for latency-sensitive tasks.
    kHigh,
    // Video priority. Use for video pipeline tasks.
    kVideo,
    // Audio priority. Use for audio pipeline tasks not including rendering.
    kAudio,
    // Low priority. Use for background tasks (e.g. logging, cleanup).
    kLow,

    // Deprecated: Use kNormal instead.
    NORMAL = kNormal,
    // Deprecated: Use kHigh instead.
    HIGH = kHigh,
    // Deprecated: Use kLow instead.
    LOW = kLow,
  };

  virtual ~TaskQueueFactory() = default;
  virtual std::unique_ptr<TaskQueueBase, TaskQueueDeleter> CreateTaskQueue(
      absl::string_view name,
      Priority priority) const = 0;
};

}  // namespace webrtc

#endif  // API_TASK_QUEUE_TASK_QUEUE_FACTORY_H_