drain_inotify.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 The Android Open Source Project
 *
 * Licensed 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.
 */
 
#pragma once
 
#include <stdint.h>
 
#include "cuttlefish/common/libs/fs/shared_fd.h"
#include "cuttlefish/result/result_type.h"
 
namespace cuttlefish {
 
/*
 * Exhaustively drain all available events from the non-blocking inotify file
 * descriptor to coalesce rapid file modifications. The file descriptor should
 * be set to non-blocking.
 *
 * Returns a bit mask of the events unioned together.
 */
Result<uint32_t> DrainInotifyEvents(SharedFD inotify_fd);
 
}  // namespace cuttlefish