src/starboard/loader_app/drain_file.h

// Copyright 2020 The Cobalt Authors. All Rights Reserved.
//
// 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.

#ifndef STARBOARD_LOADER_APP_DRAIN_FILE_H_
#define STARBOARD_LOADER_APP_DRAIN_FILE_H_

#include "starboard/time.h"
#include "starboard/types.h"

#ifdef __cplusplus
extern "C" {
#endif

// The units of time that the drain file age is represented in.
extern const SbTime kDrainFileAgeUnit;

// The amount of time of which a drain file is valid.
extern const SbTime kDrainFileMaximumAge;

// The prefix that all drain file names will have.
extern const char kDrainFilePrefix[];

// Attempts to create a drain file in |dir| with the provided |app_key|. If
// there is an existing, non-expired drain file with a matching |app_key| it
// will be used instead. Returns |true| if a file was created or reused,
// otherwise |false|.
bool DrainFileTryDrain(const char* dir, const char* app_key);

// Ranks the drain files in |dir| using DrainFileRank(), and compares the
// provided |app_key| with the best ranked app key. Returns |true| if they
// match, otherwise |false|.
bool DrainFileRankAndCheck(const char* dir, const char* app_key);

// Removed the drain files in |dir| whose app key matches |app_key|. Returns
// |true| if no files were found, or they were removed, otherwise returns
// |false|.
bool DrainFileRemove(const char* dir, const char* app_key);

// Clears the drain files in |dir|. If |app_key| is provided, all drain files
// with matching app keys are ignored. If |expired| is |true|, all non-expired
// drain files are ignored.
void DrainFileClear(const char* dir, const char* app_key, bool expired);

// Clears all files and directories in |dir| except for the drain file with an
// app key matching |app_key|.
void DrainFilePrepareDirectory(const char* dir, const char* app_key);

// Checks whether a non-expired drain file exists in |dir|. If |app_key| is
// provided, only drain files with a matching |app_key| are considered. Returns
// |true| if there is, otherwise |false|.
bool DrainFileDraining(const char* dir, const char* app_key);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // STARBOARD_LOADER_APP_DRAIN_FILE_H_