doc
csync_dbtree.h
Go to the documentation of this file.
1 /*
2  * libcsync -- a library to sync a directory with another
3  *
4  * Copyright (c) 2012 by Klaas Freitag <freitag@owncloud.com>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20 
21 /**
22  * @file csync_dbtree.h
23  *
24  * @brief Private interface of csync
25  *
26  * @defgroup csyncdbtreeInternals csync statedb internals
27  * @ingroup csyncInternalAPI
28  *
29  * @{
30  */
31 
32 #ifndef _CSYNC_DBTREE_H
33 #define _CSYNC_DBTREE_H
34 
35 #include "c_lib.h"
36 #include "csync_private.h"
37 #include "vio/csync_vio_handle.h"
38 
39 /**
40  * @brief Open a directory based on the statedb.
41  *
42  * This function reads the list of files within a directory from statedb and
43  * builds up a list in memory.
44  *
45  * @param ctx The csync context.
46  * @param name The directory name.
47  *
48  * @return 0 on success, less than 0 if an error occured with errno set.
49  */
51 
53 
55 
56 /**
57  * }@
58  */
59 #endif /* _CSYNC_DBTREE_H */
60 /* vim: set ft=c.doxygen ts=8 sw=2 et cindent: */
csync_vio_method_handle_t * csync_dbtree_opendir(CSYNC *ctx, const char *name)
Open a directory based on the statedb.
Private interface of csync.
csync_vio_file_stat_t * csync_dbtree_readdir(CSYNC *ctx, csync_vio_method_handle_t *dhandle)
csync public structure
Definition: csync_private.h:88
int csync_dbtree_closedir(CSYNC *ctx, csync_vio_method_handle_t *dhandle)
void csync_vio_method_handle_t