n_disk_cache.h

Go to the documentation of this file.

/*
 * Nilorea Library
 * Copyright (C) 2005-2026 Castagnier Mickael
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef __NILOREA_DISK_CACHE__
#define __NILOREA_DISK_CACHE__
 
#ifdef __cplusplus
extern "C" {
#endif

 
#include <stddef.h>
#include <stdint.h>
 
#include "nilorea/n_common.h"

#define N_DISK_CACHE_NAME_LEN 32

typedef struct N_DISK_CACHE N_DISK_CACHE;

N_DISK_CACHE* n_disk_cache_open(const char* dir);

void n_disk_cache_close(N_DISK_CACHE** cache);

const char* n_disk_cache_dir(const N_DISK_CACHE* cache);

int n_disk_cache_path(const N_DISK_CACHE* cache, const void* key, size_t key_len, const char* ext, char* out, size_t out_len);

int n_disk_cache_put(const N_DISK_CACHE* cache, const void* key, size_t key_len, const char* ext, const void* data, size_t len);

int n_disk_cache_get(const N_DISK_CACHE* cache, const void* key, size_t key_len, const char* ext, size_t max_len, unsigned char** data, size_t* len);

int n_disk_cache_remove(const N_DISK_CACHE* cache, const void* key, size_t key_len, const char* ext);

int n_disk_cache_size(const N_DISK_CACHE* cache, uint64_t* total);

int n_disk_cache_prune(const N_DISK_CACHE* cache, uint64_t max_bytes);

int n_disk_cache_prune_group(const N_DISK_CACHE* const* caches, int count, uint64_t max_bytes);

int n_disk_cache_expire(const N_DISK_CACHE* cache, int64_t max_age_seconds);

 
#ifdef __cplusplus
}
#endif
#endif /* __NILOREA_DISK_CACHE__ */