idle_cpu_handler.hh

Go to the documentation of this file.

/*
 * This file is open source software, licensed to you under the terms
 * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership.  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.
 */
/*
 * Copyright 2020 ScyllaDB
 */
 
#pragma once
 
#ifndef SEASTAR_MODULE
#include <seastar/util/noncopyable_function.hh>
#include <seastar/util/modules.hh>
#endif
 
 
namespace seastar {
 
SEASTAR_MODULE_EXPORT_BEGIN
 
enum class idle_cpu_handler_result {
    no_more_work,                       
    interrupted_by_higher_priority_task 
};
 
using work_waiting_on_reactor = const noncopyable_function<bool()>&;
 
using idle_cpu_handler = noncopyable_function<idle_cpu_handler_result(work_waiting_on_reactor poll)>;
 
void set_idle_cpu_handler(idle_cpu_handler&& handler);
 
SEASTAR_MODULE_EXPORT_END
 
}