fs_tree.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_FS_TREE_H
#define GNUNET_FS_TREE_H
 
#include "fs_api.h"
 
unsigned int
GNUNET_FS_compute_depth (uint64_t flen);
 
 
uint64_t
GNUNET_FS_tree_compute_tree_size (unsigned int depth);
 
 
size_t
GNUNET_FS_tree_calculate_block_size (uint64_t fsize, uint64_t offset,
                                     unsigned int depth);
 
 
struct GNUNET_FS_TreeEncoder;
 
 
typedef void (*GNUNET_FS_TreeBlockProcessor) (void *cls,
                                              const struct ContentHashKey *chk,
                                              uint64_t offset,
                                              unsigned int depth,
                                              enum GNUNET_BLOCK_Type type,
                                              const void *block,
                                              uint16_t block_size);
 
 
typedef void (*GNUNET_FS_TreeProgressCallback) (void *cls, uint64_t offset,
                                                const void *pt_block,
                                                size_t pt_size,
                                                unsigned int depth);
 
 
struct GNUNET_FS_TreeEncoder *
GNUNET_FS_tree_encoder_create (struct GNUNET_FS_Handle *h, uint64_t size,
                               void *cls, GNUNET_FS_DataReader reader,
                               GNUNET_FS_TreeBlockProcessor proc,
                               GNUNET_FS_TreeProgressCallback progress,
                               GNUNET_SCHEDULER_TaskCallback cont);
 
 
void
GNUNET_FS_tree_encoder_next (struct GNUNET_FS_TreeEncoder *te);
 
 
struct GNUNET_FS_Uri *
GNUNET_FS_tree_encoder_get_uri (struct GNUNET_FS_TreeEncoder *te);
 
 
void
GNUNET_FS_tree_encoder_finish (struct GNUNET_FS_TreeEncoder *te,
                               char **emsg);
 
 
#if 0
/* the functions below will be needed for persistence
   but are not yet implemented -- FIXME... */
void
GNUNET_FS_tree_encoder_resume_get_data (const struct GNUNET_FS_TreeEncoder *te,
                                        void **data, size_t *size);
 
 
void
GNUNET_FS_tree_encoder_resume (struct GNUNET_FS_TreeEncoder *te,
                               const void *data, size_t size);
 
#endif
 
#endif
 
/* end of fs_tree.h */